{ "consumes": [ "application/json" ], "produces": [ "application/json" ], "schemes": [ "http", "https" ], "swagger": "2.0", "info": { "title": "eTop API", "version": "v1" }, "paths": { "/v1/shop.Customer/CreateCustomer": { "post": { "tags": [ "Customer" ], "summary": "CreateCustomer", "operationId": "shop.Customer-CreateCustomer", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomer" } } } } }, "/v1/shop.Customer/DeleteCustomer": { "post": { "tags": [ "Customer" ], "summary": "DeleteCustomer", "operationId": "shop.Customer-DeleteCustomer", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrDeleteCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.Customer/GetCustomer": { "post": { "tags": [ "Customer" ], "summary": "GetCustomer", "operationId": "shop.Customer-GetCustomer", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomer" } } } } }, "/v1/shop.Customer/ListCustomers": { "post": { "tags": [ "Customer" ], "summary": "ListCustomers", "operationId": "shop.Customer-ListCustomers", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListCustomersRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomersResponse" } } } } }, "/v1/shop.Customer/UpdateCustomer": { "post": { "tags": [ "Customer" ], "summary": "UpdateCustomer", "operationId": "shop.Customer-UpdateCustomer", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomer" } } } } }, "/v1/shop.CustomerAddress/CreateAddress": { "post": { "tags": [ "CustomerAddress" ], "summary": "CreateAddress", "operationId": "shop.CustomerAddress-CreateAddress", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateCustomerAddressRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerAddress" } } } } }, "/v1/shop.CustomerAddress/DeleteAddress": { "post": { "tags": [ "CustomerAddress" ], "summary": "DeleteAddress", "operationId": "shop.CustomerAddress-DeleteAddress", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.CustomerAddress/GetAddress": { "post": { "tags": [ "CustomerAddress" ], "summary": "GetAddress", "operationId": "shop.CustomerAddress-GetAddress", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrOrderIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerAddress" } } } } }, "/v1/shop.CustomerAddress/ListAddresses": { "post": { "tags": [ "CustomerAddress" ], "summary": "ListAddresses", "operationId": "shop.CustomerAddress-ListAddresses", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListCustomerAddressesRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerAddressesResponse" } } } } }, "/v1/shop.CustomerAddress/UpdateAddress": { "post": { "tags": [ "CustomerAddress" ], "summary": "UpdateAddress", "operationId": "shop.CustomerAddress-UpdateAddress", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateCustomerAddressRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerAddress" } } } } }, "/v1/shop.CustomerGroup/CreateGroup": { "post": { "tags": [ "CustomerGroup" ], "summary": "CreateGroup", "operationId": "shop.CustomerGroup-CreateGroup", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateCustomerGroupRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerGroup" } } } } }, "/v1/shop.CustomerGroup/DeleteGroup": { "post": { "tags": [ "CustomerGroup" ], "summary": "DeleteGroup", "operationId": "shop.CustomerGroup-DeleteGroup", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.CustomerGroup/GetGroup": { "post": { "tags": [ "CustomerGroup" ], "summary": "GetGroup", "operationId": "shop.CustomerGroup-GetGroup", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerGroup" } } } } }, "/v1/shop.CustomerGroup/ListGroups": { "post": { "tags": [ "CustomerGroup" ], "summary": "ListGroups", "operationId": "shop.CustomerGroup-ListGroups", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListCustomerGroupsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerGroupsResponse" } } } } }, "/v1/shop.CustomerGroup/UpdateGroup": { "post": { "tags": [ "CustomerGroup" ], "summary": "UpdateGroup", "operationId": "shop.CustomerGroup-UpdateGroup", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateCustomerGroupRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerGroup" } } } } }, "/v1/shop.CustomerGroupRelationship/CreateRelationship": { "post": { "tags": [ "CustomerGroupRelationship" ], "summary": "CreateRelationship", "operationId": "shop.CustomerGroupRelationship-CreateRelationship", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrAddCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.CustomerGroupRelationship/DeleteRelationship": { "post": { "tags": [ "CustomerGroupRelationship" ], "summary": "DeleteRelationship", "operationId": "shop.CustomerGroupRelationship-DeleteRelationship", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrRemoveCustomerRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.CustomerGroupRelationship/ListRelationships": { "post": { "tags": [ "CustomerGroupRelationship" ], "summary": "ListRelationships", "operationId": "shop.CustomerGroupRelationship-ListRelationships", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListCustomerGroupRelationshipsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCustomerGroupRelationshipsResponse" } } } } }, "/v1/shop.Fulfillment/GetFulfillment": { "post": { "tags": [ "Fulfillment" ], "summary": "GetFulfillment", "operationId": "shop.Fulfillment-GetFulfillment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrFulfillmentIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrFulfillment" } } } } }, "/v1/shop.Fulfillment/ListFulfillments": { "post": { "tags": [ "Fulfillment" ], "summary": "ListFulfillments", "operationId": "shop.Fulfillment-ListFulfillments", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListFulfillmentsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrFulfillmentsResponse" } } } } }, "/v1/shop.History/GetChanges": { "post": { "description": "This API provides an example for webhook request content. It's not a real API.\n", "tags": [ "History" ], "summary": "GetChanges", "operationId": "shop.History-GetChanges", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktEmpty" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrCallback" } } } } }, "/v1/shop.Inventory/ListInventoryLevels": { "post": { "tags": [ "Inventory" ], "summary": "ListInventoryLevels", "operationId": "shop.Inventory-ListInventoryLevels", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListInventoryLevelsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrInventoryLevelsResponse" } } } } }, "/v1/shop.Misc/CurrentAccount": { "post": { "tags": [ "Misc" ], "summary": "CurrentAccount", "operationId": "shop.Misc-CurrentAccount", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktEmpty" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/baPublicAccountInfo" } } } } }, "/v1/shop.Misc/GetLocationList": { "post": { "tags": [ "Misc" ], "summary": "GetLocationList", "operationId": "shop.Misc-GetLocationList", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktEmpty" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrLocationResponse" } } } } }, "/v1/shop.Misc/VersionInfo": { "post": { "tags": [ "Misc" ], "summary": "VersionInfo", "operationId": "shop.Misc-VersionInfo", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktEmpty" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktVersionInfoResponse" } } } } }, "/v1/shop.Order/CancelOrder": { "post": { "tags": [ "Order" ], "summary": "CancelOrder", "operationId": "shop.Order-CancelOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCancelOrderRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrderAndFulfillments" } } } } }, "/v1/shop.Order/ConfirmOrder": { "post": { "tags": [ "Order" ], "summary": "ConfirmOrder", "operationId": "shop.Order-ConfirmOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrConfirmOrderRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.Order/CreateOrder": { "post": { "tags": [ "Order" ], "summary": "CreateOrder", "operationId": "shop.Order-CreateOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateOrderRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrder" } } } } }, "/v1/shop.Order/GetOrder": { "post": { "tags": [ "Order" ], "summary": "GetOrder", "operationId": "shop.Order-GetOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrOrderIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrderAndFulfillments" } } } } }, "/v1/shop.Order/ListOrders": { "post": { "tags": [ "Order" ], "summary": "ListOrders", "operationId": "shop.Order-ListOrders", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListOrdersRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrdersResponse" } } } } }, "/v1/shop.Product/CreateProduct": { "post": { "tags": [ "Product" ], "summary": "CreateProduct", "operationId": "shop.Product-CreateProduct", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateProductRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopProduct" } } } } }, "/v1/shop.Product/DeleteProduct": { "post": { "tags": [ "Product" ], "summary": "DeleteProduct", "operationId": "shop.Product-DeleteProduct", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetProductRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.Product/GetProduct": { "post": { "tags": [ "Product" ], "summary": "GetProduct", "operationId": "shop.Product-GetProduct", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetProductRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopProduct" } } } } }, "/v1/shop.Product/ListProducts": { "post": { "tags": [ "Product" ], "summary": "ListProducts", "operationId": "shop.Product-ListProducts", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListProductsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopProductsResponse" } } } } }, "/v1/shop.Product/UpdateProduct": { "post": { "tags": [ "Product" ], "summary": "UpdateProduct", "operationId": "shop.Product-UpdateProduct", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateProductRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopProduct" } } } } }, "/v1/shop.ProductCollection/CreateCollection": { "post": { "tags": [ "ProductCollection" ], "summary": "CreateCollection", "operationId": "shop.ProductCollection-CreateCollection", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateCollectionRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrProductCollection" } } } } }, "/v1/shop.ProductCollection/DeleteCollection": { "post": { "tags": [ "ProductCollection" ], "summary": "DeleteCollection", "operationId": "shop.ProductCollection-DeleteCollection", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetCollectionRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.ProductCollection/GetCollection": { "post": { "tags": [ "ProductCollection" ], "summary": "GetCollection", "operationId": "shop.ProductCollection-GetCollection", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetCollectionRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrProductCollection" } } } } }, "/v1/shop.ProductCollection/ListCollections": { "post": { "tags": [ "ProductCollection" ], "summary": "ListCollections", "operationId": "shop.ProductCollection-ListCollections", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListCollectionsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrProductCollectionsResponse" } } } } }, "/v1/shop.ProductCollection/UpdateCollection": { "post": { "tags": [ "ProductCollection" ], "summary": "UpdateCollection", "operationId": "shop.ProductCollection-UpdateCollection", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateCollectionRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrProductCollection" } } } } }, "/v1/shop.ProductCollectionRelationship/CreateRelationship": { "post": { "tags": [ "ProductCollectionRelationship" ], "summary": "CreateRelationship", "operationId": "shop.ProductCollectionRelationship-CreateRelationship", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateProductCollectionRelationshipRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.ProductCollectionRelationship/DeleteRelationship": { "post": { "tags": [ "ProductCollectionRelationship" ], "summary": "DeleteRelationship", "operationId": "shop.ProductCollectionRelationship-DeleteRelationship", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrRemoveProductCollectionRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.ProductCollectionRelationship/ListRelationships": { "post": { "tags": [ "ProductCollectionRelationship" ], "summary": "ListRelationships", "operationId": "shop.ProductCollectionRelationship-ListRelationships", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListProductCollectionRelationshipsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrProductCollectionRelationshipsResponse" } } } } }, "/v1/shop.Shipnow/CancelShipnowFulfillment": { "post": { "tags": [ "Shipnow" ], "summary": "CancelShipnowFulfillment", "operationId": "shop.Shipnow-CancelShipnowFulfillment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCancelShipnowFulfillmentRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktUpdatedResponse" } } } } }, "/v1/shop.Shipnow/CreateShipnowFulfillment": { "post": { "tags": [ "Shipnow" ], "summary": "CreateShipnowFulfillment", "operationId": "shop.Shipnow-CreateShipnowFulfillment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateShipnowFulfillmentRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShipnowFulfillment" } } } } }, "/v1/shop.Shipnow/GetShipnowFulfillment": { "post": { "tags": [ "Shipnow" ], "summary": "GetShipnowFulfillment", "operationId": "shop.Shipnow-GetShipnowFulfillment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrFulfillmentIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShipnowFulfillment" } } } } }, "/v1/shop.Shipnow/GetShipnowServices": { "post": { "tags": [ "Shipnow" ], "summary": "GetShipnowServices", "operationId": "shop.Shipnow-GetShipnowServices", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetShipnowServicesRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrGetShipnowServicesResponse" } } } } }, "/v1/shop.Shipping/CancelOrder": { "post": { "tags": [ "Shipping" ], "summary": "CancelOrder", "operationId": "shop.Shipping-CancelOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCancelOrderRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrderAndFulfillments" } } } } }, "/v1/shop.Shipping/CreateAndConfirmOrder": { "post": { "tags": [ "Shipping" ], "summary": "CreateAndConfirmOrder", "operationId": "shop.Shipping-CreateAndConfirmOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateAndConfirmOrderRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrderAndFulfillments" } } } } }, "/v1/shop.Shipping/GetFulfillment": { "post": { "tags": [ "Shipping" ], "summary": "GetFulfillment", "operationId": "shop.Shipping-GetFulfillment", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrFulfillmentIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrFulfillment" } } } } }, "/v1/shop.Shipping/GetOrder": { "post": { "tags": [ "Shipping" ], "summary": "GetOrder", "operationId": "shop.Shipping-GetOrder", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrOrderIDRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrOrderAndFulfillments" } } } } }, "/v1/shop.Shipping/GetShippingServices": { "post": { "tags": [ "Shipping" ], "summary": "GetShippingServices", "operationId": "shop.Shipping-GetShippingServices", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetShippingServicesRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrGetShippingServicesResponse" } } } } }, "/v1/shop.Variant/CreateVariant": { "post": { "tags": [ "Variant" ], "summary": "CreateVariant", "operationId": "shop.Variant-CreateVariant", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateVariantRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopVariant" } } } } }, "/v1/shop.Variant/DeleteVariant": { "post": { "tags": [ "Variant" ], "summary": "DeleteVariant", "operationId": "shop.Variant-DeleteVariant", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetVariantRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/ktEmpty" } } } } }, "/v1/shop.Variant/GetVariant": { "post": { "tags": [ "Variant" ], "summary": "GetVariant", "operationId": "shop.Variant-GetVariant", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrGetVariantRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopVariant" } } } } }, "/v1/shop.Variant/ListVariants": { "post": { "tags": [ "Variant" ], "summary": "ListVariants", "operationId": "shop.Variant-ListVariants", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrListVariantsRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopVariantsResponse" } } } } }, "/v1/shop.Variant/UpdateVariant": { "post": { "tags": [ "Variant" ], "summary": "UpdateVariant", "operationId": "shop.Variant-UpdateVariant", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrUpdateVariantRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrShopVariant" } } } } }, "/v1/shop.Webhook/CreateWebhook": { "post": { "tags": [ "Webhook" ], "summary": "CreateWebhook", "operationId": "shop.Webhook-CreateWebhook", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrCreateWebhookRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrWebhook" } } } } }, "/v1/shop.Webhook/DeleteWebhook": { "post": { "tags": [ "Webhook" ], "summary": "DeleteWebhook", "operationId": "shop.Webhook-DeleteWebhook", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/mrDeleteWebhookRequest" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrWebhooksResponse" } } } } }, "/v1/shop.Webhook/GetWebhooks": { "post": { "tags": [ "Webhook" ], "summary": "GetWebhooks", "operationId": "shop.Webhook-GetWebhooks", "parameters": [ { "name": "body", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ktEmpty" } } ], "responses": { "200": { "description": "A successful response", "schema": { "$ref": "#/definitions/mrWebhooksResponse" } } } } } }, "definitions": { "baCoordinates": { "type": "object", "properties": { "latitude": { "type": "integer", "format": "float32" }, "longitude": { "type": "integer", "format": "float32" } } }, "baPublicAccountInfo": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "image_url": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/jjAccountType" }, "website": { "type": "string" } } }, "bjState": { "type": "string", "enum": [ "default", "created", "assigning", "picking", "delivering", "delivered", "returning", "returned", "unknown", "undeliverable", "cancelled" ] }, "blStatus": { "type": "string", "enum": [ "Z", "P", "N" ] }, "bmStatus": { "type": "string", "enum": [ "Z", "P", "S", "N" ] }, "bnStatus": { "type": "string", "enum": [ "Z", "P", "S", "N", "NS" ] }, "bwShippingProvider": { "type": "string", "enum": [ "unknown", "all", "manual", "ghn", "ghtk", "vtpost", "etop", "partner", "ninjavan", "dhl" ] }, "csTryOnCode": { "type": "string", "enum": [ "unknown", "none", "open", "try" ] }, "dkAttribute": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" } } }, "jjAccountType": { "type": "string", "enum": [ "unknown", "partner", "shop", "affiliate", "carrier", "etop" ] }, "kfIDs": { "description": "Filter by id value\n", "type": "string" }, "ktCursorPageInfo": { "type": "object", "properties": { "after": { "type": "string" }, "before": { "type": "string" }, "limit": { "type": "integer" }, "next": { "type": "string" }, "prev": { "type": "string" }, "sort": { "type": "string" } } }, "ktCursorPaging": { "type": "object", "properties": { "after": { "type": "string" }, "before": { "type": "string" }, "limit": { "type": "integer" }, "sort": { "type": "string" } } }, "ktEmpty": { "type": "object" }, "ktError": { "type": "object", "properties": { "code": { "type": "string" }, "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "msg": { "type": "string" } } }, "ktIDRequest": { "type": "object", "required": [ "id" ], "properties": { "id": { "type": "string", "format": "int64" } } }, "ktUpdatedResponse": { "type": "object", "properties": { "updated": { "type": "integer" } } }, "ktVersionInfoResponse": { "type": "object", "properties": { "meta": { "type": "object", "additionalProperties": { "type": "string" } }, "service": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "version": { "type": "string" } } }, "ljCustomerType": { "description": "Deprecated values: \"independent\"\\n", "type": "string", "enum": [ "unknown", "individual", "organization", "anonymous" ] }, "miSubstate": { "type": "string", "enum": [ "default", "pick_fail", "delivery_fail", "devivery_giveup", "return_fail", "cancelling" ] }, "mrAddCustomerRequest": { "type": "object", "properties": { "customer_id": { "type": "string", "format": "int64" }, "group_id": { "type": "string", "format": "int64" } } }, "mrCallback": { "type": "object", "properties": { "changes": { "type": "array", "items": { "$ref": "#/definitions/mrChange" } }, "id": { "type": "string", "format": "int64" } } }, "mrCancelOrderRequest": { "type": "object", "properties": { "cancel_reason": { "type": "string" }, "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrCancelShipnowFulfillmentRequest": { "type": "object", "properties": { "cancel_reason": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "shipping_code": { "type": "string" } } }, "mrCarrierInfo": { "type": "object", "properties": { "image_url": { "type": "string" }, "name": { "type": "string" } } }, "mrChange": { "type": "object", "properties": { "change_type": { "type": "string" }, "changed": { "$ref": "#/definitions/mrChangeOneOf" }, "entity": { "type": "string" }, "latest": { "$ref": "#/definitions/mrLatestOneOf" }, "time": { "type": "string", "format": "date-time" } } }, "mrChangeOneOf": { "type": "object", "properties": { "customer": { "$ref": "#/definitions/mrCustomer" }, "customer_address": { "$ref": "#/definitions/mrCustomerAddress" }, "customer_group": { "$ref": "#/definitions/mrCustomerGroup" }, "customer_group_relationship": { "$ref": "#/definitions/mrCustomerGroupRelationship" }, "fulfillment": { "$ref": "#/definitions/mrFulfillment" }, "inventory_level": { "$ref": "#/definitions/mrInventoryLevel" }, "order": { "$ref": "#/definitions/mrOrder" }, "product": { "$ref": "#/definitions/mrShopProduct" }, "product_collection": { "$ref": "#/definitions/mrProductCollection" }, "product_collection_relationship": { "$ref": "#/definitions/mrProductCollectionRelationship" }, "shipnow_fulfillment": { "$ref": "#/definitions/mrShipnowFulfillment" }, "variant": { "$ref": "#/definitions/mrShopVariant" } } }, "mrConfirmOrderRequest": { "type": "object", "properties": { "auto_inventory_voucher": { "allOf": [ { "description": "enum ('create', 'confirm')\n" }, { "$ref": "#/definitions/rtAutoInventoryVoucher" } ] }, "inventory_policy": { "allOf": [ { "description": "enum ('obey', 'ignore')\n" }, { "$ref": "#/definitions/rdInventoryPolicy" } ] }, "order_id": { "type": "string", "format": "int64" } } }, "mrCoordinates": { "type": "object", "properties": { "latitude": { "type": "integer", "format": "float32" }, "longitude": { "type": "integer", "format": "float32" } } }, "mrCreateAndConfirmOrderRequest": { "type": "object", "properties": { "basket_value": { "description": "basket_value = SUM(lines.retail_price)\n", "type": "integer" }, "customer_address": { "$ref": "#/definitions/mrOrderAddress" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "external_meta": { "type": "object", "additionalProperties": { "type": "string" } }, "external_url": { "type": "string" }, "fee_lines": { "type": "array", "items": { "$ref": "#/definitions/qdOrderFeeLine" } }, "lines": { "type": "array", "items": { "$ref": "#/definitions/mrOrderLine" } }, "order_discount": { "type": "integer" }, "order_note": { "type": "string" }, "shipping": { "$ref": "#/definitions/mrOrderShipping" }, "shipping_address": { "$ref": "#/definitions/mrOrderAddress" }, "total_amount": { "type": "integer" }, "total_discount": { "type": "integer" }, "total_fee": { "type": "integer" }, "total_items": { "type": "integer" } } }, "mrCreateCollectionRequest": { "type": "object", "properties": { "description": { "type": "string" }, "name": { "type": "string" }, "short_desc": { "type": "string" } } }, "mrCreateCustomerAddressRequest": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "company": { "type": "string" }, "coordinates": { "$ref": "#/definitions/mrCoordinates" }, "country": { "type": "string" }, "customer_id": { "type": "string", "format": "int64" }, "district_code": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "phone": { "type": "string" }, "position": { "type": "string" }, "province_code": { "type": "string" }, "ward_code": { "type": "string" } } }, "mrCreateCustomerGroupRequest": { "type": "object", "properties": { "name": { "type": "string" } } }, "mrCreateCustomerRequest": { "type": "object", "required": [ "full_name", "phone" ], "properties": { "birthday": { "type": "string" }, "email": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "full_name": { "type": "string" }, "gender": { "$ref": "#/definitions/pwGender" }, "note": { "type": "string" }, "phone": { "type": "string" }, "type": { "allOf": [ { "description": "enum ('independent', 'individual', 'organization')\n\nDeprecated values: \"independent\"\\n" }, { "$ref": "#/definitions/ljCustomerType" } ] } } }, "mrCreateOrderRequest": { "type": "object", "properties": { "basket_value": { "description": "basket_value = SUM(lines.retail_price)\n", "type": "integer" }, "customer_address": { "$ref": "#/definitions/mrOrderAddress" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "external_meta": { "type": "object", "additionalProperties": { "type": "string" } }, "external_url": { "type": "string" }, "fee_lines": { "type": "array", "items": { "$ref": "#/definitions/qdOrderFeeLine" } }, "lines": { "type": "array", "items": { "$ref": "#/definitions/mrOrderLine" } }, "order_discount": { "type": "integer" }, "order_note": { "type": "string" }, "payment_method": { "$ref": "#/definitions/yiPaymentMethod" }, "shipping": { "$ref": "#/definitions/mrOrderShipping" }, "shipping_address": { "$ref": "#/definitions/mrOrderAddress" }, "total_amount": { "type": "integer" }, "total_discount": { "type": "integer" }, "total_fee": { "type": "integer" }, "total_items": { "type": "integer" } } }, "mrCreateProductCollectionRelationshipRequest": { "type": "object", "properties": { "collection_id": { "type": "string", "format": "int64" }, "product_id": { "type": "string", "format": "int64" } } }, "mrCreateProductRequest": { "type": "object", "properties": { "brand_id": { "type": "string", "format": "int64" }, "code": { "type": "string" }, "cost_price": { "type": "integer" }, "description": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" }, "unit": { "type": "string" } } }, "mrCreateShipnowFulfillmentRequest": { "type": "object", "required": [ "pickup_address", "delivery_points", "shipping_service_code", "shipping_service_fee" ], "properties": { "coupon": { "type": "string" }, "delivery_points": { "type": "array", "items": { "$ref": "#/definitions/mrShipnowDeliveryPointRequest" } }, "external_id": { "type": "string" }, "pickup_address": { "$ref": "#/definitions/mrShipnowAddress" }, "shipping_note": { "type": "string" }, "shipping_service_code": { "type": "string" }, "shipping_service_fee": { "type": "integer" } } }, "mrCreateVariantRequest": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/dkAttribute" } }, "code": { "type": "string" }, "cost_price": { "type": "integer" }, "description": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "product_id": { "type": "string", "format": "int64" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" } } }, "mrCreateWebhookRequest": { "type": "object", "properties": { "entities": { "type": "array", "items": { "$ref": "#/definitions/njEntityType" } }, "fields": { "type": "array", "items": { "type": "string" } }, "metadata": { "type": "string" }, "url": { "type": "string" } } }, "mrCustomer": { "type": "object", "properties": { "birthday": { "type": "string" }, "code": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "email": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "full_name": { "type": "string" }, "gender": { "$ref": "#/definitions/pwGender" }, "id": { "type": "string", "format": "int64" }, "note": { "type": "string" }, "phone": { "type": "string" }, "shop_id": { "type": "string", "format": "int64" }, "status": { "$ref": "#/definitions/blStatus" }, "type": { "$ref": "#/definitions/ljCustomerType" }, "updated_at": { "type": "string", "format": "date-time" } } }, "mrCustomerAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "company": { "type": "string" }, "coordinates": { "$ref": "#/definitions/baCoordinates" }, "customer_id": { "type": "string", "format": "int64" }, "deleted": { "type": "boolean" }, "district": { "type": "string" }, "district_code": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "phone": { "type": "string" }, "position": { "type": "string" }, "province": { "type": "string" }, "province_code": { "type": "string" }, "ward": { "type": "string" }, "ward_code": { "type": "string" } } }, "mrCustomerAddressFilter": { "type": "object", "properties": { "customer_id": { "$ref": "#/definitions/kfIDs" }, "phone": { "type": "string" } } }, "mrCustomerAddressesResponse": { "type": "object", "properties": { "addresses": { "type": "array", "items": { "$ref": "#/definitions/mrCustomerAddress" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrCustomerFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrCustomerGroup": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "shop_id": { "type": "string", "format": "int64" } } }, "mrCustomerGroupFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrCustomerGroupRelationship": { "type": "object", "properties": { "customer_id": { "type": "string", "format": "int64" }, "deleted": { "type": "boolean" }, "group_id": { "type": "string", "format": "int64" } } }, "mrCustomerGroupRelationshipFilter": { "type": "object", "properties": { "customer_id": { "$ref": "#/definitions/kfIDs" }, "group_id": { "$ref": "#/definitions/kfIDs" } } }, "mrCustomerGroupRelationshipsResponse": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/ktCursorPageInfo" }, "relationship": { "type": "array", "items": { "$ref": "#/definitions/mrCustomerGroupRelationship" } } } }, "mrCustomerGroupsResponse": { "type": "object", "properties": { "customer_groups": { "type": "array", "items": { "$ref": "#/definitions/mrCustomerGroup" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrCustomersResponse": { "type": "object", "properties": { "customers": { "type": "array", "items": { "$ref": "#/definitions/mrCustomer" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrDeleteCustomerRequest": { "type": "object", "properties": { "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrDeleteWebhookRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" } } }, "mrDistrict": { "type": "object", "properties": { "name": { "type": "string" }, "wards": { "type": "array", "items": { "$ref": "#/definitions/mrWard" } } } }, "mrFulfillment": { "type": "object", "properties": { "actual_cod_amount": { "type": "integer" }, "actual_shipping_service_fee": { "type": "integer" }, "basket_value": { "type": "integer" }, "cancel_reason": { "type": "string" }, "cancelled_at": { "type": "string", "format": "date-time" }, "carrier": { "$ref": "#/definitions/bwShippingProvider" }, "chargeable_weight": { "type": "integer" }, "closed_at": { "type": "string", "format": "date-time" }, "cod_amount": { "type": "integer" }, "confirm_status": { "$ref": "#/definitions/blStatus" }, "created_at": { "type": "string", "format": "date-time" }, "estimated_delivery_at": { "type": "string", "format": "date-time" }, "estimated_pickup_at": { "type": "string", "format": "date-time" }, "etop_payment_status": { "$ref": "#/definitions/bmStatus" }, "id": { "type": "string", "format": "int64" }, "include_insurance": { "type": "boolean" }, "order_id": { "type": "string", "format": "int64" }, "pickup_address": { "$ref": "#/definitions/mrOrderAddress" }, "return_address": { "$ref": "#/definitions/mrOrderAddress" }, "self_url": { "type": "string" }, "shipping_address": { "$ref": "#/definitions/mrOrderAddress" }, "shipping_code": { "type": "string" }, "shipping_note": { "type": "string" }, "shipping_service_code": { "type": "string" }, "shipping_service_fee": { "type": "integer" }, "shipping_service_name": { "type": "string" }, "shipping_state": { "$ref": "#/definitions/sfState" }, "shipping_status": { "$ref": "#/definitions/bnStatus" }, "shipping_substate": { "$ref": "#/definitions/miSubstate" }, "shop_id": { "type": "string", "format": "int64" }, "status": { "$ref": "#/definitions/bnStatus" }, "total_items": { "type": "integer" }, "try_on": { "$ref": "#/definitions/csTryOnCode" }, "updated_at": { "type": "string", "format": "date-time" } } }, "mrFulfillmentIDRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "shipping_code": { "type": "string" } } }, "mrFulfillmentsResponse": { "type": "object", "properties": { "fulfillments": { "type": "array", "items": { "$ref": "#/definitions/mrFulfillment" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrGetCollectionRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" } } }, "mrGetCustomerRequest": { "type": "object", "properties": { "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrGetProductRequest": { "type": "object", "properties": { "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrGetShipnowServicesRequest": { "type": "object", "properties": { "coupon": { "type": "string" }, "delivery_points": { "type": "array", "items": { "$ref": "#/definitions/mrShipnowDeliveryPointShortVersion" } }, "pickup_address": { "$ref": "#/definitions/mrShipnowAddressShortVersion" } } }, "mrGetShipnowServicesResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/definitions/mrShipnowService" } } } }, "mrGetShippingServicesRequest": { "type": "object", "properties": { "basket_value": { "type": "integer" }, "chargeable_weight": { "description": "in gram (g)\n", "type": "integer" }, "cod_amount": { "type": "integer" }, "connection_ids": { "type": "array", "items": { "type": "string", "format": "int64" } }, "gross_weight": { "description": "in gram (g)\n", "type": "integer" }, "height": { "description": "in centimetre (cm)\n", "type": "integer" }, "include_insurance": { "type": "boolean" }, "length": { "description": "in centimetre (cm)\n", "type": "integer" }, "pickup_address": { "$ref": "#/definitions/mrLocationAddress" }, "shipping_address": { "$ref": "#/definitions/mrLocationAddress" }, "width": { "description": "in centimetre (cm)\n", "type": "integer" } } }, "mrGetShippingServicesResponse": { "type": "object", "properties": { "services": { "type": "array", "items": { "$ref": "#/definitions/mrShippingService" } } } }, "mrGetVariantRequest": { "type": "object", "properties": { "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrInventoryLevel": { "type": "object", "properties": { "available_quantity": { "type": "integer" }, "picked_quantity": { "type": "integer" }, "reserved_quantity": { "type": "integer" }, "updated_at": { "type": "string", "format": "date-time" }, "variant_id": { "type": "string", "format": "int64" } } }, "mrInventoryLevelsResponse": { "type": "object", "properties": { "inventory_levels": { "type": "array", "items": { "$ref": "#/definitions/mrInventoryLevel" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrLatestOneOf": { "type": "object", "properties": { "customer": { "$ref": "#/definitions/mrCustomer" }, "customer_address": { "$ref": "#/definitions/mrCustomerAddress" }, "customer_group": { "$ref": "#/definitions/mrCustomerGroup" }, "customer_group_relationship": { "$ref": "#/definitions/mrCustomerGroupRelationship" }, "fulfillment": { "$ref": "#/definitions/mrFulfillment" }, "inventory_level": { "$ref": "#/definitions/mrInventoryLevel" }, "order": { "$ref": "#/definitions/mrOrder" }, "product": { "$ref": "#/definitions/mrShopProduct" }, "product_collection": { "$ref": "#/definitions/mrProductCollection" }, "product_collection_relationship": { "$ref": "#/definitions/mrProductCollectionRelationship" }, "shipnow_fulfillment": { "$ref": "#/definitions/mrShipnowFulfillment" }, "variant": { "$ref": "#/definitions/mrShopVariant" } } }, "mrListCollectionsFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrListCollectionsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrListCollectionsFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListCustomerAddressesRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrCustomerAddressFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListCustomerGroupRelationshipsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrCustomerGroupRelationshipFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListCustomerGroupsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrCustomerGroupFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListCustomersRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrCustomerFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListFulfillmentsFilter": { "type": "object", "properties": { "order_id": { "$ref": "#/definitions/kfIDs" } } }, "mrListFulfillmentsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrListFulfillmentsFilter" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListInventoryLevelsFilter": { "type": "object", "properties": { "variant_id": { "$ref": "#/definitions/kfIDs" } } }, "mrListInventoryLevelsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrListInventoryLevelsFilter" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListOrdersFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrListOrdersRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrListOrdersFilter" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListProductCollectionRelationshipsFilter": { "type": "object", "properties": { "collection_id": { "$ref": "#/definitions/kfIDs" }, "product_id": { "$ref": "#/definitions/kfIDs" } } }, "mrListProductCollectionRelationshipsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrListProductCollectionRelationshipsFilter" }, "include_deleted": { "description": "**TODO:** add cursor paging\nPaging *common.CursorPaging `json:\"paging\"`\n", "type": "boolean" } } }, "mrListProductsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrProductFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrListVariantsRequest": { "type": "object", "properties": { "filter": { "$ref": "#/definitions/mrVariantFilter" }, "include_deleted": { "type": "boolean" }, "paging": { "$ref": "#/definitions/ktCursorPaging" } } }, "mrLocationAddress": { "type": "object", "properties": { "district": { "type": "string" }, "province": { "type": "string" }, "ward": { "type": "string" } } }, "mrLocationResponse": { "type": "object", "properties": { "provinces": { "type": "array", "items": { "$ref": "#/definitions/mrProvince" } } } }, "mrOrder": { "type": "object", "properties": { "basket_value": { "type": "integer" }, "cancel_reason": { "type": "string" }, "cancelled_at": { "type": "string", "format": "date-time" }, "closed_at": { "type": "string", "format": "date-time" }, "code": { "type": "string" }, "confirm_status": { "$ref": "#/definitions/blStatus" }, "confirmed_at": { "type": "string", "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "customer_address": { "$ref": "#/definitions/mrOrderAddress" }, "etop_payment_status": { "$ref": "#/definitions/bmStatus" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "external_url": { "type": "string" }, "fee_lines": { "type": "array", "items": { "$ref": "#/definitions/qdOrderFeeLine" } }, "fulfillment_shipping_status": { "$ref": "#/definitions/bnStatus" }, "id": { "type": "string", "format": "int64" }, "lines": { "type": "array", "items": { "$ref": "#/definitions/mrOrderLine" } }, "order_discount": { "type": "integer" }, "order_note": { "type": "string" }, "pre_order": { "type": "boolean" }, "processed_at": { "type": "string", "format": "date-time" }, "self_url": { "type": "string" }, "shipping": { "$ref": "#/definitions/mrOrderShipping" }, "shipping_address": { "$ref": "#/definitions/mrOrderAddress" }, "shop_id": { "type": "string", "format": "int64" }, "status": { "$ref": "#/definitions/bnStatus" }, "total_amount": { "type": "integer" }, "total_discount": { "type": "integer" }, "total_fee": { "type": "integer" }, "total_items": { "type": "integer" }, "updated_at": { "type": "string", "format": "date-time" } } }, "mrOrderAddress": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "company": { "type": "string" }, "district": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "phone": { "type": "string" }, "province": { "type": "string" }, "ward": { "type": "string" } } }, "mrOrderAndFulfillments": { "type": "object", "properties": { "fulfillment_errors": { "type": "array", "items": { "$ref": "#/definitions/ktError" } }, "fulfillments": { "type": "array", "items": { "$ref": "#/definitions/mrFulfillment" } }, "order": { "$ref": "#/definitions/mrOrder" } } }, "mrOrderIDRequest": { "type": "object", "properties": { "code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" } } }, "mrOrderLine": { "type": "object", "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/dkAttribute" } }, "image_url": { "type": "string" }, "list_price": { "type": "integer" }, "payment_price": { "description": "payment_price = retail_price - discount_per_item\n", "type": "integer" }, "product_id": { "type": "string", "format": "int64" }, "product_name": { "type": "string" }, "quantity": { "type": "integer" }, "retail_price": { "type": "integer" }, "variant_id": { "type": "string", "format": "int64" } } }, "mrOrderShipping": { "type": "object", "properties": { "carrier": { "allOf": [ { "description": "**Deprecated:** use connection_id instead\n" }, { "$ref": "#/definitions/bwShippingProvider" } ] }, "chargeable_weight": { "type": "integer" }, "cod_amount": { "type": "integer" }, "connection_id": { "type": "string", "format": "int64" }, "gross_weight": { "type": "integer" }, "height": { "type": "integer" }, "include_insurance": { "type": "boolean" }, "length": { "type": "integer" }, "pickup_address": { "$ref": "#/definitions/mrOrderAddress" }, "return_address": { "$ref": "#/definitions/mrOrderAddress" }, "shipping_note": { "type": "string" }, "shipping_service_code": { "type": "string" }, "shipping_service_fee": { "type": "integer" }, "shipping_service_name": { "type": "string" }, "try_on": { "$ref": "#/definitions/csTryOnCode" }, "width": { "type": "integer" } } }, "mrOrdersResponse": { "type": "object", "properties": { "orders": { "type": "array", "items": { "$ref": "#/definitions/mrOrder" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrProductCollection": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "shop_id": { "type": "string", "format": "int64" }, "short_desc": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" } } }, "mrProductCollectionRelationship": { "type": "object", "properties": { "collection_id": { "type": "string", "format": "int64" }, "deleted": { "type": "boolean" }, "product_id": { "type": "string", "format": "int64" } } }, "mrProductCollectionRelationshipsResponse": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/ktCursorPageInfo" }, "relationships": { "type": "array", "items": { "$ref": "#/definitions/mrProductCollectionRelationship" } } } }, "mrProductCollectionsResponse": { "type": "object", "properties": { "collections": { "type": "array", "items": { "$ref": "#/definitions/mrProductCollection" } }, "paging": { "$ref": "#/definitions/ktCursorPageInfo" } } }, "mrProductFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrProvince": { "type": "object", "properties": { "districts": { "type": "array", "items": { "$ref": "#/definitions/mrDistrict" } }, "name": { "type": "string" } } }, "mrRemoveCustomerRequest": { "type": "object", "properties": { "customer_id": { "type": "string", "format": "int64" }, "group_id": { "type": "string", "format": "int64" } } }, "mrRemoveProductCollectionRequest": { "type": "object", "properties": { "collection_id": { "type": "string", "format": "int64" }, "product_id": { "type": "string", "format": "int64" } } }, "mrShipnowAddress": { "type": "object", "properties": { "address": { "type": "string" }, "company": { "type": "string" }, "coordinates": { "allOf": [ { "description": "Vui lòng cung cấp lat. , long. để lấy được giá chính xác nhất\n" }, { "$ref": "#/definitions/mrCoordinates" } ] }, "district": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "phone": { "type": "string" }, "province": { "type": "string" }, "ward": { "type": "string" } } }, "mrShipnowAddressShortVersion": { "type": "object", "properties": { "address": { "type": "string" }, "coordinates": { "allOf": [ { "description": "Vui lòng cung cấp lat. , long. để lấy được giá chính xác nhất\n" }, { "$ref": "#/definitions/mrCoordinates" } ] }, "district": { "type": "string" }, "province": { "type": "string" }, "ward": { "type": "string" } } }, "mrShipnowDeliveryPoint": { "type": "object", "required": [ "gross_weight", "cod_amount" ], "properties": { "basket_value": { "type": "integer" }, "chargeable_weight": { "type": "integer" }, "cod_amount": { "type": "integer" }, "gross_weight": { "type": "integer" }, "lines": { "type": "array", "items": { "$ref": "#/definitions/mrOrderLine" } }, "shipping_address": { "$ref": "#/definitions/mrShipnowAddress" }, "shipping_note": { "type": "string" }, "shipping_state": { "allOf": [ { "description": "Map với trạng thái của đơn hàng\n" }, { "$ref": "#/definitions/bjState" } ] } } }, "mrShipnowDeliveryPointRequest": { "type": "object", "required": [ "gross_weight", "cod_amount", "basket_value", "lines" ], "properties": { "basket_value": { "type": "integer" }, "chargeable_weight": { "type": "integer" }, "cod_amount": { "type": "integer" }, "gross_weight": { "type": "integer" }, "lines": { "type": "array", "items": { "$ref": "#/definitions/mrOrderLine" } }, "shipping_address": { "$ref": "#/definitions/mrShipnowAddress" }, "shipping_note": { "type": "string" } } }, "mrShipnowDeliveryPointShortVersion": { "type": "object", "properties": { "cod_amount": { "type": "integer" }, "shipping_address": { "$ref": "#/definitions/mrShipnowAddressShortVersion" } } }, "mrShipnowFulfillment": { "type": "object", "properties": { "actual_shipping_service_fee": { "type": "integer" }, "basket_value": { "type": "integer" }, "cancel_reason": { "type": "string" }, "carrier_info": { "$ref": "#/definitions/mrCarrierInfo" }, "chargeable_weight": { "type": "integer" }, "cod_amount": { "type": "integer" }, "confirm_status": { "$ref": "#/definitions/blStatus" }, "coupon": { "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "delivery_points": { "type": "array", "items": { "$ref": "#/definitions/mrShipnowDeliveryPoint" } }, "external_id": { "type": "string" }, "gross_weight": { "type": "integer" }, "id": { "type": "string", "format": "int64" }, "order_ids": { "type": "array", "items": { "type": "string", "format": "int64" } }, "pickup_address": { "$ref": "#/definitions/mrShipnowAddress" }, "shipping_code": { "type": "string" }, "shipping_note": { "type": "string" }, "shipping_service_code": { "type": "string" }, "shipping_service_description": { "type": "string" }, "shipping_service_fee": { "type": "integer" }, "shipping_service_name": { "type": "string" }, "shipping_shared_link": { "type": "string" }, "shipping_state": { "$ref": "#/definitions/bjState" }, "shipping_status": { "$ref": "#/definitions/bnStatus" }, "shop_id": { "type": "string", "format": "int64" }, "status": { "$ref": "#/definitions/bnStatus" }, "updated_at": { "type": "string", "format": "date-time" } } }, "mrShipnowService": { "type": "object", "properties": { "carrier_info": { "$ref": "#/definitions/mrCarrierInfo" }, "code": { "type": "string" }, "description": { "type": "string" }, "fee": { "type": "integer" }, "name": { "type": "string" } } }, "mrShippingService": { "type": "object", "properties": { "carrier": { "allOf": [ { "description": "**Deprecated:**\n" }, { "$ref": "#/definitions/bwShippingProvider" } ] }, "carrier_info": { "$ref": "#/definitions/mrCarrierInfo" }, "code": { "type": "string" }, "estimated_delivery_at": { "type": "string", "format": "date-time" }, "estimated_pickup_at": { "type": "string", "format": "date-time" }, "fee": { "type": "integer" }, "name": { "description": "**Deprecated:** use carrier info instead\n", "type": "string" } } }, "mrShopProduct": { "type": "object", "required": [ "id" ], "properties": { "brand_id": { "type": "string", "format": "int64" }, "category_id": { "type": "string", "format": "int64" }, "created_at": { "type": "string", "format": "date-time" }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" }, "status": { "$ref": "#/definitions/blStatus" }, "updated_at": { "type": "string", "format": "date-time" }, "variants": { "type": "array", "items": { "$ref": "#/definitions/mrShopVariant" } } } }, "mrShopProductsResponse": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/ktCursorPageInfo" }, "products": { "type": "array", "items": { "$ref": "#/definitions/mrShopProduct" } } } }, "mrShopVariant": { "type": "object", "required": [ "id" ], "properties": { "attributes": { "type": "array", "items": { "$ref": "#/definitions/dkAttribute" } }, "code": { "type": "string" }, "cost_price": { "type": "integer" }, "deleted": { "type": "boolean" }, "description": { "type": "string" }, "external_code": { "type": "string" }, "external_id": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "image_urls": { "type": "array", "items": { "type": "string" } }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" }, "status": { "$ref": "#/definitions/blStatus" } } }, "mrShopVariantsResponse": { "type": "object", "properties": { "paging": { "$ref": "#/definitions/ktCursorPageInfo" }, "shop_variants": { "type": "array", "items": { "$ref": "#/definitions/mrShopVariant" } } } }, "mrUpdateCollectionRequest": { "type": "object", "properties": { "description": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "name": { "type": "string" }, "short_desc": { "type": "string" } } }, "mrUpdateCustomerAddressRequest": { "type": "object", "properties": { "address1": { "type": "string" }, "address2": { "type": "string" }, "company": { "type": "string" }, "coordinates": { "$ref": "#/definitions/baCoordinates" }, "country": { "type": "string" }, "district_code": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "phone": { "type": "string" }, "position": { "type": "string" }, "province_code": { "type": "string" }, "ward_code": { "type": "string" } } }, "mrUpdateCustomerGroupRequest": { "type": "object", "properties": { "id": { "type": "string", "format": "int64" }, "name": { "type": "string" } } }, "mrUpdateCustomerRequest": { "type": "object", "properties": { "birthday": { "type": "string" }, "email": { "type": "string" }, "full_name": { "type": "string" }, "gender": { "$ref": "#/definitions/pwGender" }, "id": { "type": "string", "format": "int64" }, "note": { "type": "string" }, "phone": { "type": "string" }, "type": { "description": "enum ('individual', 'organization','independent')\n", "type": "string" } } }, "mrUpdateProductRequest": { "type": "object", "required": [ "id" ], "properties": { "brand_id": { "type": "string", "format": "int64" }, "cost_price": { "type": "integer" }, "description": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" }, "unit": { "type": "string" } } }, "mrUpdateVariantRequest": { "type": "object", "required": [ "id" ], "properties": { "code": { "type": "string" }, "cost_price": { "type": "integer" }, "description": { "type": "string" }, "id": { "type": "string", "format": "int64" }, "list_price": { "type": "integer" }, "name": { "type": "string" }, "note": { "type": "string" }, "retail_price": { "type": "integer" }, "short_desc": { "type": "string" } } }, "mrVariantFilter": { "type": "object", "properties": { "id": { "$ref": "#/definitions/kfIDs" } } }, "mrWard": { "type": "object", "properties": { "name": { "type": "string" } } }, "mrWebhook": { "type": "object", "properties": { "created_at": { "type": "string", "format": "date-time" }, "entities": { "type": "array", "items": { "$ref": "#/definitions/njEntityType" } }, "fields": { "type": "array", "items": { "type": "string" } }, "id": { "type": "string", "format": "int64" }, "metadata": { "type": "string" }, "states": { "$ref": "#/definitions/mrWebhookStates" }, "url": { "type": "string" } } }, "mrWebhookError": { "type": "object", "properties": { "error": { "type": "string" }, "resp_body": { "type": "string" }, "resp_status": { "type": "integer" }, "retried": { "type": "integer" }, "sent_at": { "type": "string", "format": "date-time" } } }, "mrWebhookStates": { "type": "object", "properties": { "last_error": { "$ref": "#/definitions/mrWebhookError" }, "last_sent_at": { "type": "string", "format": "date-time" }, "state": { "type": "string" } } }, "mrWebhooksResponse": { "type": "object", "properties": { "webhooks": { "type": "array", "items": { "$ref": "#/definitions/mrWebhook" } } } }, "njEntityType": { "type": "string", "enum": [ "order", "fulfillment", "product", "variant", "customer", "inventory_level", "customer_address", "customer_group", "customer_group_relationship", "product_collection", "product_collection_relationship", "shipnow_fulfillment" ] }, "ojFeeType": { "type": "string", "enum": [ "other", "shipping", "tax" ] }, "pwGender": { "type": "string", "enum": [ "unknown", "male", "female", "other" ] }, "qdOrderFeeLine": { "type": "object", "required": [ "name", "amount" ], "properties": { "amount": { "type": "integer" }, "code": { "type": "string" }, "desc": { "type": "string" }, "name": { "type": "string" }, "type": { "$ref": "#/definitions/ojFeeType" } } }, "rdInventoryPolicy": { "type": "string", "enum": [ "unknown", "obey", "ignore" ] }, "rtAutoInventoryVoucher": { "type": "string", "enum": [ "unknown", "create", "confirm" ] }, "sfState": { "type": "string", "enum": [ "unknown", "default", "created", "confirmed", "processing", "picking", "holding", "returning", "returned", "delivering", "delivered", "cancelled", "undeliverable" ] }, "yiPaymentMethod": { "type": "string", "enum": [ "unknown", "cod", "bank", "other", "vtpay", "momo", "bankdeposit", "manual" ] } }, "tags": [ { "name": "Customer" }, { "name": "CustomerAddress" }, { "name": "CustomerGroup" }, { "name": "CustomerGroupRelationship" }, { "name": "Fulfillment" }, { "name": "History" }, { "name": "Inventory" }, { "name": "Misc" }, { "name": "Order" }, { "name": "Product" }, { "name": "ProductCollection" }, { "name": "ProductCollectionRelationship" }, { "name": "Shipnow" }, { "name": "Shipping" }, { "name": "Variant" }, { "name": "Webhook" } ] }