{
"openapi": "3.0.1",
"info": {
"title": "Connector",
"version": "15bf1dd, 2025-12-05T10:59:41Z",
"description": "Enhanced Quivo API documentation with additional descriptions and examples"
},
"servers": [
{
"url": "https://api.quivo.co/"
}
],
"tags": [
{
"name": "addresses"
},
{
"name": "apiKeyRequests"
},
{
"name": "articles"
},
{
"name": "audits"
},
{
"name": "bundles"
},
{
"name": "carriers"
},
{
"name": "contacts"
},
{
"name": "countries"
},
{
"name": "currencies"
},
{
"name": "customerInquiries"
},
{
"name": "dashboards"
},
{
"name": "files"
},
{
"name": "fulfillmentPlans"
},
{
"name": "inbounds"
},
{
"name": "items"
},
{
"name": "languages"
},
{
"name": "notifications"
},
{
"name": "orders"
},
{
"name": "ping"
},
{
"name": "returnApp"
},
{
"name": "returnLinks"
},
{
"name": "returns"
},
{
"name": "sellers"
},
{
"name": "shipments"
},
{
"name": "shippingServiceGroups"
},
{
"name": "shopOrders"
},
{
"name": "shops"
},
{
"name": "status"
},
{
"name": "storedAddresses"
},
{
"name": "subscriptionPackages"
},
{
"name": "subscriptions"
},
{
"name": "track"
},
{
"name": "transports"
},
{
"name": "users"
},
{
"name": "warehouses"
}
],
"paths": {
"/addresses/{sellerId}": {
"get": {
"tags": [
"addresses"
],
"summary": "Get list of addresses stored in the seller's address book",
"operationId": "addressGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "ADD RESPONSE DESCRIPTION HERE - 200",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddressGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"addresses"
],
"summary": "Store a new address in the seller's address book",
"operationId": "addressPost",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/addresses/{sellerId}/default/{defaultAddressType}": {
"get": {
"tags": [
"addresses"
],
"summary": "Get default address of given type",
"operationId": "addressDefaultGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "defaultAddressType",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"SHIP_FROM",
"PICKUP",
"RETURN"
]
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"addresses"
],
"summary": "Set default address of given type",
"operationId": "addressDefaultPut",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "defaultAddressType",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"SHIP_FROM",
"PICKUP",
"RETURN"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressId"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"addresses"
],
"summary": "Unset default address of given type",
"operationId": "addressDefaultDelete",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "defaultAddressType",
"in": "path",
"required": true,
"schema": {
"type": "string",
"enum": [
"SHIP_FROM",
"PICKUP",
"RETURN"
]
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/addresses/{sellerId}/{addressId}": {
"put": {
"tags": [
"addresses"
],
"summary": "Update a stored address in the seller's address book",
"operationId": "addressPut",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "addressId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddressGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"addresses"
],
"summary": "Delete a stored address from the seller's address book",
"operationId": "addressDelete",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "addressId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/apiKeyRequests": {
"get": {
"tags": [
"apiKeyRequests"
],
"summary": "Get list of API requests",
"operationId": "getApiKeyRequests",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ApiRequestGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/apiKeyRequests/{sellerId}": {
"post": {
"tags": [
"apiKeyRequests"
],
"summary": "Request API Key",
"operationId": "requestApiKey",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles": {
"get": {
"tags": [
"articles"
],
"summary": "Search articles",
"operationId": "searchGetArticles",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleGetSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{articleId}": {
"get": {
"tags": [
"articles"
],
"summary": "Get details of article by articleId",
"operationId": "articlesGetArticle",
"parameters": [
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}": {
"post": {
"tags": [
"articles"
],
"summary": "Create a new article",
"operationId": "articlesPostArticle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticlePost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/identifier/{articleIdentifier}": {
"get": {
"tags": [
"articles"
],
"summary": "Get details of article by articleIdentifier",
"operationId": "articlesGetArticle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleIdentifier",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/validate": {
"post": {
"tags": [
"articles"
],
"summary": "Validate article PUT request",
"operationId": "articlesPostValidate",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticlePost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/{articleId}": {
"get": {
"tags": [
"articles"
],
"summary": "Get details of article by articleId",
"operationId": "articlesGetArticle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"articles"
],
"summary": "Update existing article by id",
"operationId": "articlesPutArticle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"articles"
],
"summary": "Update existing article by id",
"operationId": "articlesDeleteArticle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/{articleId}/images": {
"post": {
"tags": [
"articles"
],
"summary": "Stores the article image information",
"operationId": "articlesPostImage",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleImagePost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleImageGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/{articleId}/images/upload": {
"post": {
"tags": [
"articles"
],
"summary": "Creates a new upload link for the article image",
"operationId": "articlesPostImageLink",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
},
{
"name": "mimeType",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleImageUpload"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/{articleId}/images/{uuid}": {
"delete": {
"tags": [
"articles"
],
"summary": "Deletes existing article image by uuid",
"operationId": "articlesDeleteImage",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
},
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/articles/{sellerId}/{articleId}/validate": {
"put": {
"tags": [
"articles"
],
"summary": "Validate article PUT request",
"operationId": "articlesPutValidate",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "articleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an article (product/SKU) in the system."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ArticleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/audits": {
"get": {
"tags": [
"audits"
],
"summary": "Search audits",
"operationId": "auditSearch",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/bundles": {
"get": {
"tags": [
"bundles"
],
"summary": "Search bundles",
"operationId": "searchGetBundles",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleGetSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/bundles/{sellerId}": {
"post": {
"tags": [
"bundles"
],
"summary": "Create a new bundle",
"operationId": "bundlesPostBundle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundlePost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/bundles/{sellerId}/{bundleId}": {
"get": {
"tags": [
"bundles"
],
"summary": "Get details of bundle by bundleId",
"operationId": "bundlesGetBundle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "bundleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"bundles"
],
"summary": "Update existing bundle by id",
"operationId": "bundlesPutBundle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "bundleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundleGetDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"bundles"
],
"summary": "Delete existing article by id",
"operationId": "bundlesDeleteBundle",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "bundleId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundleGetDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/carriers": {
"get": {
"tags": [
"carriers"
],
"summary": "Get list of all carriers",
"operationId": "carrierGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CarrierGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/contacts/{sellerId}": {
"get": {
"tags": [
"contacts"
],
"summary": "Get all contacts with subscription types for the given seller",
"operationId": "contactsGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"contacts"
],
"summary": "Create a new contact for the given seller",
"operationId": "contactPost",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/contacts/{sellerId}/{contactId}": {
"put": {
"tags": [
"contacts"
],
"summary": "Updates an existing contact for the given seller",
"operationId": "contactPut",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "contactId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ContactGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"contacts"
],
"summary": "Deletes contact for the given seller",
"operationId": "contactDelete",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "contactId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/countries": {
"get": {
"tags": [
"countries"
],
"summary": "Get list of all countries",
"operationId": "countryGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/currencies": {
"get": {
"tags": [
"currencies"
],
"summary": "Get list of all currencies",
"operationId": "currencyGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/currencies/exchangeRates": {
"get": {
"tags": [
"currencies"
],
"summary": "Get list of all currency exchange rates",
"operationId": "currencyExchangeRateGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CurrencyExchangeRateGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries": {
"get": {
"tags": [
"customerInquiries"
],
"summary": "Search customer inquiries",
"operationId": "searchGetCustomerInquiries",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerInquirySummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"customerInquiries"
],
"summary": "Create a new customer inquiry.",
"operationId": "postCustomerInquiry",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries/attachments": {
"post": {
"tags": [
"customerInquiries"
],
"summary": "Creates a new upload link for the customer inquiry attachment",
"operationId": "postAttachmentLink",
"parameters": [
{
"name": "mimeType",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AttachmentPostResult"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries/{customerInquiryId}": {
"get": {
"tags": [
"customerInquiries"
],
"summary": "Get details of customer inquiry by customerInquiryId",
"operationId": "getCustomerInquiry",
"parameters": [
{
"name": "customerInquiryId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries/{customerInquiryId}/messages": {
"post": {
"tags": [
"customerInquiries"
],
"summary": "Creates a new message for the customer inquiry",
"operationId": "postCustomerInquiryMessage",
"parameters": [
{
"name": "customerInquiryId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryMessagePost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries/{customerInquiryId}/ratings": {
"post": {
"tags": [
"customerInquiries"
],
"summary": "Creates rating message and adds rating to the customer inquiry",
"operationId": "postCustomerInquiryRating",
"parameters": [
{
"name": "customerInquiryId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RatingPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/customerInquiries/{customerInquiryId}/resolve": {
"post": {
"tags": [
"customerInquiries"
],
"summary": "Resolves customer inquiry and adds resolve message to it",
"operationId": "postCustomerInquiryResolve",
"parameters": [
{
"name": "customerInquiryId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerInquiryGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/dashboards": {
"get": {
"tags": [
"dashboards"
],
"summary": "Get list of supported dashboard graphs",
"operationId": "dashboardGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"dashboards"
],
"summary": "Request dashboards",
"operationId": "dashboardPost",
"parameters": [
{
"name": "sellerId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "warehouse",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "range",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "rangeStart",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "rangeEnd",
"in": "query",
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Response"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/files": {
"post": {
"tags": [
"files"
],
"summary": "Initiate file upload",
"operationId": "filesPost",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilePostResult"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}": {
"get": {
"tags": [
"fulfillmentPlans"
],
"summary": "List fulfillment plan when entries for given seller",
"operationId": "fulfillmentPlansGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanWhenGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Create a new fulfillment plan entry for the given seller",
"operationId": "fulfillmentPlansPost",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanWhenPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanWhenGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/preview": {
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Previews the results of a fulfillment plan entry for the given seller",
"operationId": "fulfillmentPlansPreview",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PreviewRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewFulfillmentOrder"
}
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/skuAddition": {
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Add a new SKU addition to the fulfillment plan of the given seller",
"operationId": "fulfillmentPlansPostSkuAddition",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddSkuAdditionRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/skuFork": {
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Add a new SKU fork to the fulfillment plan of the given seller. This is usally used to map sets of products, where one SKU consists of several other SKUs.",
"operationId": "fulfillmentPlansPostSkuFork",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddSkuForkRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/skuMapping": {
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Add a new SKU mapping to the fulfillment plan of the given seller",
"operationId": "fulfillmentPlansPostSkuMapping",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddSkuMappingRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/skuRemoval": {
"post": {
"tags": [
"fulfillmentPlans"
],
"summary": "Add a new SKU removal to the fulfillment plan of the given seller",
"operationId": "fulfillmentPlansPostSkuRemoval",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddSkuRemovalRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/fulfillmentPlans/{sellerId}/{planWhenId}": {
"put": {
"tags": [
"fulfillmentPlans"
],
"summary": "Updates an existing fulfillment plan entry for the given seller.",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "fulfillmentPlansPut",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "planWhenId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanWhenPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanWhenGet"
}
}
}
}
},
"x-codegen-request-body-name": "body"
},
"delete": {
"tags": [
"fulfillmentPlans"
],
"summary": "Deletes the given fulfillment plan when entry for the given seller",
"operationId": "fulfillmentPlansDelete",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "planWhenId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/inbounds": {
"get": {
"tags": [
"inbounds"
],
"summary": "Search inbounds",
"operationId": "searchGetInbounds",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"inbounds"
],
"summary": "Create a new inbound.",
"operationId": "postInbound",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundPostResult"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/inbounds/{inboundId}": {
"get": {
"tags": [
"inbounds"
],
"summary": "Get details of inbound by inboundId",
"operationId": "getInbound",
"parameters": [
{
"name": "inboundId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"inbounds"
],
"summary": "Update existing inbound by id",
"operationId": "putInbound",
"parameters": [
{
"name": "inboundId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InboundGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"inbounds"
],
"summary": "Cancel inbound by inboundId",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "inboundCancel",
"parameters": [
{
"name": "inboundId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/inbounds/{inboundId}/validate": {
"put": {
"tags": [
"inbounds"
],
"summary": "Check missing inbound data and update it",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "inboundValidate",
"parameters": [
{
"name": "inboundId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/items": {
"get": {
"tags": [
"items"
],
"summary": "Search items",
"operationId": "itemGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemInfo"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/itemHistories/{warehouseId}/{sellerId}": {
"get": {
"tags": [
"items"
],
"summary": "Get details of item history",
"operationId": "itemHistoryGet",
"parameters": [
{
"name": "warehouseId",
"in": "path",
"description": "The unique identifier for the warehouse location where items are stored and orders are fulfilled.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "sellerId",
"in": "path",
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "query",
"in": "query",
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "searchAfter",
"in": "query",
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "movementFrom",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "movementTo",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemHistorySummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/seller/{sellerId}/refresh": {
"post": {
"tags": [
"items"
],
"summary": "Refresh/Sync inventory with Warehouse",
"operationId": "itemsInventorySyncWithWarehouse",
"parameters": [
{
"name": "sellerId",
"in": "path",
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/{itemId}": {
"get": {
"tags": [
"items"
],
"summary": "Get details of item by itemId",
"operationId": "itemGetItem",
"parameters": [
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemInfo"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/{itemId}/movements": {
"get": {
"tags": [
"items"
],
"summary": "Search item movements",
"operationId": "itemGetMovements",
"parameters": [
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
},
{
"name": "movementFrom",
"in": "query",
"schema": {
"type": "string"
}
},
{
"name": "movementTo",
"in": "query",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemMovements"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/{itemId}/refresh": {
"post": {
"tags": [
"items"
],
"summary": "Refresh/sync inventory with warehouse for an item",
"operationId": "itemRefreshWithWarehouse",
"parameters": [
{
"name": "itemId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ItemInfo"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/items/{warehouseId}/{sellerId}": {
"get": {
"tags": [
"items"
],
"summary": "Search items by warehouse and seller",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "itemGetWarehouseSeller",
"parameters": [
{
"name": "warehouseId",
"in": "path",
"description": "The unique identifier for the warehouse location where items are stored and orders are fulfilled.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "sellerId",
"in": "path",
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "query",
"in": "query",
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "searchAfter",
"in": "query",
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemInfo"
}
}
}
}
}
}
}
},
"/items/{warehouseId}/{sellerId}/storages": {
"get": {
"tags": [
"items"
],
"summary": "Search items storages by warehouse and seller",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "itemStorageGetWarehouseSeller",
"parameters": [
{
"name": "warehouseId",
"in": "path",
"description": "The unique identifier for the warehouse location where items are stored and orders are fulfilled.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "sellerId",
"in": "path",
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "isBlocked",
"in": "query",
"description": "Filter storages by blocked or non-blocked",
"schema": {
"type": "boolean"
}
},
{
"name": "sort",
"in": "query",
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemInfo"
}
}
}
}
}
}
}
},
"/languages": {
"get": {
"tags": [
"languages"
],
"summary": "Get list of all languages",
"operationId": "languageGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/LanguageGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications": {
"get": {
"tags": [
"notifications"
],
"summary": "Search for notifications",
"operationId": "notificationGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/id/{notificationId}": {
"get": {
"tags": [
"notifications"
],
"summary": "Get details of notification by id",
"operationId": "notificationsGetNotification",
"parameters": [
{
"name": "notificationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"notifications"
],
"summary": "Sets the resolved timestamp to the current date",
"operationId": "notificationResolve",
"parameters": [
{
"name": "notificationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"notifications"
],
"summary": "Sets the resolved timestamp to null",
"operationId": "notificationRemoveResolve",
"parameters": [
{
"name": "notificationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/notificationTypes": {
"get": {
"tags": [
"notifications"
],
"summary": "Get list of all notification types with categories",
"operationId": "notificationGetTypes",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationTypeDetail"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/test-email": {
"post": {
"tags": [
"notifications"
],
"summary": "Sends test email",
"operationId": "notificationTestEmail",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationDetailImportantAdmin"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/{hash}": {
"get": {
"tags": [
"notifications"
],
"summary": "Get details of notification by hash",
"operationId": "notificationsGetNotification",
"parameters": [
{
"name": "hash",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationDetail"
}
}
}
}
},
"deprecated": true,
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"notifications"
],
"summary": "Sets the resolved timestamp to the current date",
"operationId": "notificationResolve",
"parameters": [
{
"name": "hash",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"deprecated": true,
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"notifications"
],
"summary": "Sets the resolved timestamp to null",
"operationId": "notificationRemoveResolve",
"parameters": [
{
"name": "hash",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"deprecated": true,
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/{notificationId}/seen": {
"post": {
"tags": [
"notifications"
],
"summary": "Sets the resolved timestamp to the current date",
"operationId": "notificationSeen",
"parameters": [
{
"name": "notificationId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/notifications/{sellerId}/notificationTypes": {
"get": {
"tags": [
"notifications"
],
"summary": "Get list of all notification types with categories",
"operationId": "notificationGetTypesSeller",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationTypeDetail"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders": {
"get": {
"tags": [
"orders"
],
"summary": "Search for orders",
"description": "This request retrieves a paginated list of orders that supports query, sorting, and pagination parameters to filter and structure the results.",
"operationId": "orderGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "Returns an array of summarized order details, including key identifiers, status, and shipping information, filtered and sorted according to the request parameters.",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderSummary"
}
}
}
}
}
}
},
"post": {
"tags": [
"orders"
],
"summary": "Create order",
"operationId": "orderPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "Returns the result of the order creation attempt, including the newly assigned 'orderId' if successful, or status and error details if validation fails.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPostResult"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "Submits a new order for processing, including essential details like delivery address, order identifier, and item positions."
}
},
"/orders/attachments/upload": {
"post": {
"tags": [
"orders"
],
"summary": "Creates a new upload link for the order attachment",
"operationId": "newOrderPostAttachmentLink",
"parameters": [
{
"name": "mimeType",
"in": "query",
"description": "Mime type of the attachment",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderAttachmentUpload"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/entry/sellersWarehouses": {
"get": {
"tags": [
"orders"
],
"summary": "Get sellers and warehouses for order entry",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderEntrySellersWarehousesGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderEntrySellerWarehouse"
}
}
}
}
}
},
"deprecated": true
}
},
"/orders/entry/{sellerId}/countries": {
"get": {
"tags": [
"orders"
],
"summary": "Get countries for order entry",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderEntryCountriesGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderEntryCountry"
}
}
}
}
}
}
}
},
"/orders/entry/{sellerId}/{warehouseId}/countries": {
"get": {
"tags": [
"orders"
],
"summary": "Get countries for order entry",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderEntryCountriesGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "warehouseId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the warehouse location where items are stored and orders are fulfilled."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderEntryCountry"
}
}
}
}
}
}
}
},
"/orders/extract": {
"post": {
"tags": [
"orders"
],
"summary": "Extract orders from a file exported by a shop system",
"operationId": "orderPostExtract",
"requestBody": {
"content": {
"application/octet-stream": {
"schema": {
"$ref": "#/components/schemas/InputStream"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderDetail"
}
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}": {
"get": {
"tags": [
"orders"
],
"summary": "Get details of order by orderId",
"operationId": "orderGetOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderDetailWithAttachments"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"patch": {
"tags": [
"orders"
],
"summary": "Update a processing order",
"operationId": "orderPutOrder",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPut"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/address": {
"put": {
"tags": [
"orders"
],
"summary": "Update the address of an order",
"operationId": "orderPutOrderAddress",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
},
{
"name": "type",
"in": "query",
"schema": {
"type": "string",
"enum": [
"DELIVERY",
"INVOICE",
"DELIVERY_AND_INVOICE"
]
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderPutDeliveryAddress"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/attachments": {
"post": {
"tags": [
"orders"
],
"summary": "Stores the order attachment information",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderPostAttachment",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The unique identifier for an order.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderAttachmentPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderAttachmentGet"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/orders/{orderId}/attachments/upload": {
"post": {
"tags": [
"orders"
],
"summary": "Creates a new upload link for the order attachment",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderPostAttachmentLink",
"parameters": [
{
"name": "orderId",
"in": "path",
"description": "The unique identifier for an order.",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "mimeType",
"in": "query",
"description": "Mime type of the attachment ",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderAttachmentUpload"
}
}
}
}
}
}
},
"/orders/{orderId}/attachments/{attachmentId}": {
"put": {
"tags": [
"orders"
],
"summary": "Updates the order attachment",
"operationId": "orderPutAttachment",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "string"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderAttachmentGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"orders"
],
"summary": "Deletes an order attachment information",
"operationId": "orderDeleteAttachment",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
},
{
"name": "attachmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/cancelRequest": {
"post": {
"tags": [
"orders"
],
"summary": "Request cancellation of an order by orderId",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderPostCancelRequest",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/orders/{orderId}/confirmFulfillment": {
"patch": {
"tags": [
"orders"
],
"summary": "Update a processing order",
"operationId": "orderPutConfirmFulfillment",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderConfirmFulfillment"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/planFulfillment": {
"post": {
"tags": [
"orders"
],
"summary": "Adds Fulfillment plan and changes status of an order to PROCESSING",
"operationId": "orderPlanFulfillment",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/planFulfillmentAsync": {
"post": {
"tags": [
"orders"
],
"summary": "Adds Fulfillment plan and changes status of an order to PROCESSING",
"operationId": "orderPlanFulfillmentAsync",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/refetch": {
"post": {
"tags": [
"orders"
],
"summary": "Refetch order positions and delivery address information from shop and update order. For now only Shopify, Shopware, Shopware6 and InnoNature shops are supported",
"operationId": "refetchOrderInformation",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/refetchOrderAttachments": {
"post": {
"tags": [
"orders"
],
"summary": "Refetch order attachments information from shop and update order.For now only Shopware and Shopware6 shops are supported",
"operationId": "refetchOrderAttachments",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderDetailWithAttachments"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/refetchOrderLines": {
"post": {
"tags": [
"orders"
],
"summary": "Refetch order positions information from shop, update order and create a new fulfillment order for it.For now only Shopware shop is supported",
"operationId": "refetchOrderLines",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrderDetail"
}
}
}
}
},
"deprecated": true,
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/orders/{orderId}/removePIIData": {
"delete": {
"tags": [
"orders"
],
"summary": "Removes personally identifiable information from order.",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderRemovePIIData",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "boolean"
}
}
}
}
}
}
},
"/orders/{orderId}/removePIIDataAsync": {
"delete": {
"tags": [
"orders"
],
"summary": "Removes personally identifiable information from order.",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "orderRemovePIIDataAsync",
"parameters": [
{
"name": "orderId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for an order."
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
}
}
},
"/ping": {
"get": {
"tags": [
"ping"
],
"summary": "Ping the API",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "pingGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResponse"
}
}
}
}
}
}
},
"/returnApp/book": {
"post": {
"tags": [
"returnApp"
],
"summary": "Book a return shipment label",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "shipmentsBookReturn",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookReturnRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/returnApp/{hash}": {
"get": {
"tags": [
"returnApp"
],
"summary": "Verifies that hash is valid",
"operationId": "verifyReturnShipmentLink",
"parameters": [
{
"name": "hash",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyReturnShipmentLinkResponse"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/returnLinks": {
"get": {
"tags": [
"returnLinks"
],
"summary": "Search returnLinks",
"operationId": "searchGetReturnLinks",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnLinkSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"returnLinks"
],
"summary": "Create a new returnLink.",
"operationId": "postReturnLink",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/returnLinks/{returnLinkId}": {
"get": {
"tags": [
"returnLinks"
],
"summary": "Get details of returnLink by returnLinkId",
"operationId": "getReturnLink",
"parameters": [
{
"name": "returnLinkId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"returnLinks"
],
"summary": "Update existing returnLink by returnLinkId",
"operationId": "putReturnLink",
"parameters": [
{
"name": "returnLinkId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkGet"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"returnLinks"
],
"summary": "Deleting returnLink by id",
"operationId": "deleteReturnLink",
"parameters": [
{
"name": "returnLinkId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnLinkGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/returns": {
"get": {
"tags": [
"returns"
],
"summary": "Search for returns",
"operationId": "returnGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnShipmentSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/returns/{returnShipmentId}": {
"get": {
"tags": [
"returns"
],
"summary": "Get details of return by returnShipmentId",
"operationId": "returnGetReturn",
"parameters": [
{
"name": "returnShipmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnShipmentDetail"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"put": {
"tags": [
"returns"
],
"summary": "Marks return as customer examined.",
"operationId": "returnPutCustomerExamined",
"parameters": [
{
"name": "returnShipmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerExaminedRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReturnShipmentDetail"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/sellers": {
"get": {
"tags": [
"sellers"
],
"summary": "Search for sellers",
"operationId": "sellersGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SellerGetSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/sellers/{id}": {
"get": {
"tags": [
"sellers"
],
"summary": "Get seller by sellerId",
"operationId": "sellersGetSeller",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/sellers/{id}/logos": {
"post": {
"tags": [
"sellers"
],
"summary": "Stores the logo image",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "sellersPostLogo",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the seller to which the logo should be added",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerLogoPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerGet"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/sellers/{id}/logos/upload": {
"post": {
"tags": [
"sellers"
],
"summary": "Creates a new upload link for the seller logo image",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "sellersPostLogoLink",
"parameters": [
{
"name": "id",
"in": "path",
"description": "Id of the seller to which the logo image should be uploaded",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "mimeType",
"in": "query",
"description": "Mime type of the logo image ",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LogoUpload"
}
}
}
}
}
}
},
"/shipments": {
"get": {
"tags": [
"shipments"
],
"summary": "Search for booked shipments",
"operationId": "shipmentGet",
"parameters": [
{
"name": "query",
"in": "query",
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields.",
"schema": {
"type": "string"
}
},
{
"name": "sort",
"in": "query",
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc').",
"schema": {
"type": "string"
}
},
{
"name": "page",
"in": "query",
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided.",
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "searchAfter",
"in": "query",
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination.",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookedShipmentSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shipments/attachments/upload": {
"post": {
"tags": [
"shipments"
],
"summary": "Creates a new upload link for the shipment attachment",
"operationId": "newShipmentPostAttachmentLink",
"parameters": [
{
"name": "mimeType",
"in": "query",
"description": "Mime type of the attachment",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShipmentAttachmentUpload"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shipments/book": {
"post": {
"tags": [
"shipments"
],
"summary": "Book a shipment label",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "shipmentsBook",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/shipments/bookBatchAsync": {
"post": {
"tags": [
"shipments"
],
"summary": "Book a batch of shipment labels",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "shipmentsBookBatchAsync",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookBatchAsyncRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/shipments/bookShopAsync": {
"post": {
"tags": [
"shipments"
],
"summary": "Book shipments for orders stored in shop",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "shipmentsBookShopAsync",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookShopAsyncRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body"
}
},
"/shipments/documentLink": {
"get": {
"tags": [
"shipments"
],
"summary": "Get a download link for a document",
"operationId": "shipmentGetDocumentLink",
"parameters": [
{
"name": "shipmentDocumentId",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Link"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shipments/estimate": {
"post": {
"tags": [
"shipments"
],
"summary": "Estimate the price of shipment labels",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "shipmentsEstimate",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EstimateResponse"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/shipments/pickups": {
"get": {
"tags": [
"shipments"
],
"summary": "Search for booked pickups for booked shipments",
"operationId": "shipmentPickupsGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BookedPickupGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"shipments"
],
"summary": "Book a pickup for booked shipments",
"operationId": "shipmentPickupsPost",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PickupsPostRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shipments/{bookedShipmentId}": {
"get": {
"tags": [
"shipments"
],
"summary": "Get details of a booked shipment",
"operationId": "shipmentShipmentGet",
"parameters": [
{
"name": "bookedShipmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BookedShipmentGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"shipments"
],
"summary": "Cancel a booked shipment",
"operationId": "shipmentDelete",
"parameters": [
{
"name": "bookedShipmentId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shippingServiceGroups": {
"get": {
"tags": [
"shippingServiceGroups"
],
"summary": "Get list of all shipping service groups.",
"operationId": "shippingServiceGroupGet",
"parameters": [
{
"name": "showDeleted",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingServiceGroupGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shippingServiceGroups/countries/{sellerId}": {
"get": {
"tags": [
"shippingServiceGroups"
],
"summary": "Get list of all countries per shipping service group.",
"operationId": "shippingServiceGroupCountryGetSeller",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingServiceGroupCountryExtendedGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shippingServiceGroups/{sellerId}": {
"get": {
"tags": [
"shippingServiceGroups"
],
"summary": "Get list of all shipping service groups for a seller.",
"operationId": "shippingServiceGroupGetSeller",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
},
{
"name": "showDeleted",
"in": "query",
"schema": {
"type": "boolean"
}
},
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShippingServiceGroupGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shops": {
"get": {
"tags": [
"shops"
],
"summary": "Search for shops",
"operationId": "shopsGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'.",
"schema": {
"type": "string"
}
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShopGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shops/authorize": {
"post": {
"tags": [
"shops"
],
"summary": "Generate a refresh_token based on provided auth_code for shop configuration.",
"operationId": "shopAuthorize",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopAuthorizeRequest"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopAuthorizeResult"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/shops/{shopId}/orders": {
"get": {
"tags": [
"shopOrders"
],
"summary": "Search for orders in a shop",
"operationId": "shopOrdersGet",
"parameters": [
{
"name": "shopId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
},
{
"name": "pageToken",
"in": "query",
"description": "Specifies which page to load. If not specified, the first page is loaded.",
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ShopOrdersGetResult"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/status": {
"get": {
"tags": [
"status"
],
"summary": "Get service status",
"operationId": "statusGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StatusGetResponse"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/storedAddresses": {
"get": {
"tags": [
"storedAddresses"
],
"summary": "Search storedAddresses",
"operationId": "searchGetStoredAddresses",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StoredAddress"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/storedAddresses/{id}": {
"get": {
"tags": [
"storedAddresses"
],
"summary": "Get details of storedAddress by storedAddressId",
"operationId": "getStoredAddress",
"parameters": [
{
"name": "id",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/StoredAddressGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/subscriptionPackages": {
"get": {
"tags": [
"subscriptionPackages"
],
"summary": "Lists available subscription packages",
"operationId": "subscriptionPackagesGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionPackageConfigSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/subscriptionPackages/{sellerId}": {
"get": {
"tags": [
"subscriptionPackages"
],
"summary": "Get properties of seller subscription package",
"operationId": "sellerSubscriptionPackageGet",
"parameters": [
{
"name": "sellerId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The unique identifier for the seller account. This ID is used to scope operations to a specific seller's data and resources."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SellerSubscriptionPackageInfoGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/subscriptions": {
"get": {
"tags": [
"subscriptions"
],
"summary": "Gets all subscriptions.",
"operationId": "subscriptionsGet",
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SubscriptionGet"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"subscriptions"
],
"summary": "Creates a subscription for the given seller and entity",
"description": "ADD ENDPOINT DESCRIPTION HERE",
"operationId": "subscriptionsPostSubscription",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionGet"
}
}
}
}
},
"x-codegen-request-body-name": "body"
}
},
"/subscriptions/{uuid}": {
"get": {
"tags": [
"subscriptions"
],
"summary": "Retrieves a subscription by uuid",
"operationId": "subscriptionsGetSubscription",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"delete": {
"tags": [
"subscriptions"
],
"summary": "Deletes an existing subscription by uuid",
"operationId": "subscriptionsDeleteSubscription",
"parameters": [
{
"name": "uuid",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/track/gwc/shipsy/{trackingNumber}": {
"get": {
"tags": [
"track"
],
"summary": "Fetches tracking link for GWC tracking number",
"operationId": "fetchTrackingLink",
"parameters": [
{
"name": "trackingNumber",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/transports": {
"get": {
"tags": [
"transports"
],
"summary": "Search transport inquiries",
"operationId": "searchGetTransports",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TransportSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
},
"post": {
"tags": [
"transports"
],
"summary": "Create a new transport inquiry and notify transport department.",
"operationId": "postTransport",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportPost"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportPostResult"
}
}
}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/transports/{transportId}": {
"get": {
"tags": [
"transports"
],
"summary": "Get details of transport inquiry by transportId",
"operationId": "getTransport",
"parameters": [
{
"name": "transportId",
"in": "path",
"required": true,
"schema": {
"type": "integer",
"format": "int64"
}
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TransportGet"
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/users/link": {
"post": {
"tags": [
"users"
],
"summary": "Link username/password user with Social Login like Google",
"operationId": "linkUsers",
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LinkRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/users/{username}/mfa": {
"put": {
"tags": [
"users"
],
"summary": "Change role of an existing user",
"operationId": "usersPutMfaPreference",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MfaPreferenceRequest"
}
}
},
"required": false
},
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"x-codegen-request-body-name": "body",
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/users/{username}/resetPassword": {
"post": {
"tags": [
"users"
],
"summary": "Reset the password of an existing user",
"operationId": "usersResetPassword",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/users/{username}/sync": {
"put": {
"tags": [
"users"
],
"summary": "Sync user with cognito",
"operationId": "syncUser",
"parameters": [
{
"name": "username",
"in": "path",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"default": {
"description": "successful operation",
"content": {}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
},
"/warehouses": {
"get": {
"tags": [
"warehouses"
],
"summary": "Get list of all warehouses",
"operationId": "warehouseGet",
"parameters": [
{
"name": "query",
"in": "query",
"schema": {
"type": "string"
},
"description": "Search query string used to filter results. This field supports specific syntax for filtering across multiple fields."
},
{
"name": "sort",
"in": "query",
"schema": {
"type": "string"
},
"description": "Optional sorting criteria for the results. Format is typically 'field:direction' (e.g., 'created:desc')."
},
{
"name": "page",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The page number to retrieve when using offset-based pagination. Ignored if 'searchAfter' is provided."
},
{
"name": "searchAfter",
"in": "query",
"schema": {
"type": "string"
},
"description": "Used for cursor-based pagination. Pass the 'sort' key value from the last item of the previous page to retrieve the next set of results efficiently. Overrides 'page'."
},
{
"name": "pageSize",
"in": "query",
"schema": {
"type": "integer",
"format": "int64"
},
"description": "The maximum number of items to return per page. Used for both offset and cursor-based pagination."
}
],
"responses": {
"200": {
"description": "successful operation",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WarehouseSummary"
}
}
}
}
}
},
"description": "ADD ENDPOINT DESCRIPTION HERE"
}
}
},
"components": {
"schemas": {
"AddSkuAdditionRequest": {
"type": "object",
"properties": {
"skuToAdd": {
"type": "string"
},
"whenSku": {
"type": "string"
}
},
"description": "ADD SCHEMA DESCRIPTION HERE - AddSkuAdditionRequest"
},
"AddSkuForkRequest": {
"type": "object",
"properties": {
"fromSku": {
"type": "string"
},
"to": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AddSkuForkTo"
}
}
}
},
"AddSkuForkTo": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"piecePrice": {
"type": "number"
}
}
},
"AddSkuMappingRequest": {
"type": "object",
"properties": {
"externalSku": {
"type": "string"
},
"sku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
}
}
},
"AddSkuRemovalRequest": {
"type": "object",
"properties": {
"sku": {
"type": "string"
}
}
},
"AdditionalAddressIdentifier": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"GLN",
"AMAZON_FCID",
"SHOP_SPECIFIC",
"STORE_ID"
]
},
"identifier": {
"type": "string"
}
}
},
"AdditionalTrackingNumberGet": {
"type": "object",
"properties": {
"trackingNumber": {
"type": "string"
},
"reference": {
"type": "string"
}
}
},
"Address": {
"type": "object",
"properties": {
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"identifierType": {
"type": "string",
"enum": [
"GLN",
"AMAZON_FCID",
"SHOP_SPECIFIC",
"STORE_ID"
]
},
"identifier": {
"type": "string"
},
"additionalAddressIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalAddressIdentifier"
}
},
"empty": {
"type": "boolean"
}
}
},
"AddressData": {
"required": [
"city",
"countryIso2",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the person.
Usually this is the first and last name."
},
"company": {
"type": "string",
"description": "Name of the company."
},
"phone": {
"type": "string",
"description": "Phone number.
The phone number is usually optional."
},
"email": {
"type": "string",
"description": "E-Mail address."
},
"zip": {
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City.
The city should always be specified."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country.
The country should always be specified."
},
"street": {
"type": "string",
"description": "Street (or Address Line 1).
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
}
}
},
"AddressDetail": {
"type": "object",
"properties": {
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"AddressGet": {
"type": "object",
"properties": {
"defaultFor": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"SHIP_FROM",
"PICKUP",
"RETURN"
]
}
},
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"AddressId": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
}
}
},
"AddressPost": {
"type": "object",
"properties": {
"defaultFor": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"SHIP_FROM",
"PICKUP",
"RETURN"
]
}
},
"name": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"ApiRequestGet": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"initiator": {
"type": "string"
},
"sellerName": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"APPROVED",
"REJECTED",
"PENDING",
"DELETED",
"EXPIRED"
]
},
"comment": {
"type": "string"
},
"approvedBy": {
"type": "string"
},
"value": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"ArticleGetDetail": {
"required": [
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"articleType": {
"type": "string",
"enum": [
"PRODUCT",
"CARTON"
]
},
"barcode": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"supplierReferenceNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"alternativeBarcodes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"lotRequired": {
"type": "boolean"
},
"expirationDateRequired": {
"type": "boolean"
},
"serialNumberRequired": {
"type": "boolean"
},
"canShipWithoutCarton": {
"type": "boolean"
},
"length": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"width": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"height": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"customsContentDescription": {
"type": "string"
},
"countryOfOrigin": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"salesPrice": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"insuranceValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"unNumber": {
"type": "string"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of article.",
"example": "{\"attr1\":\"val1\"}"
},
"itemGroup": {
"type": "string"
},
"lottableBatchRequired": {
"type": "boolean"
},
"alternativeNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringI18nDetail"
}
},
"tariffNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"alternativeSalesPrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"alternativeInsuranceValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"alternativeCustomsValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"packagingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackagingUnitDetail"
}
},
"lotNumberPriorities": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"minimumQuantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumQuantityDetail"
}
},
"minimumExpirationDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimumExpirationDateDetail"
}
},
"minimumShelfLives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumShelfLifeDetail"
}
},
"dummyExpirationDate": {
"type": "string",
"format": "date-time"
},
"dummyLotNumber": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageDetail"
}
},
"warnings": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MessageDetail"
}
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"articleIdentifier": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleImageGet"
}
},
"lengthM": {
"type": "number"
},
"widthM": {
"type": "number"
},
"heightM": {
"type": "number"
},
"grossWeightKG": {
"type": "number"
},
"netWeightKG": {
"type": "number"
},
"tags": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"ArticleGetSummary": {
"required": [
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"articleType": {
"type": "string",
"enum": [
"PRODUCT",
"CARTON"
]
},
"barcode": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"supplierReferenceNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"alternativeBarcodes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"lotRequired": {
"type": "boolean"
},
"expirationDateRequired": {
"type": "boolean"
},
"serialNumberRequired": {
"type": "boolean"
},
"canShipWithoutCarton": {
"type": "boolean"
},
"length": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"width": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"height": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"customsContentDescription": {
"type": "string"
},
"countryOfOrigin": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"salesPrice": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"insuranceValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"unNumber": {
"type": "string"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of article.",
"example": "{\"attr1\":\"val1\"}"
},
"itemGroup": {
"type": "string"
},
"lottableBatchRequired": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int64"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"articleIdentifier": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleImageGet"
}
},
"minimumQuantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumQuantityDetail"
}
},
"packagingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackagingUnitDetail"
}
},
"minimumExpirationDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimumExpirationDateDetail"
}
},
"minimumShelfLives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumShelfLifeDetail"
}
},
"tariffNumber": {
"type": "string"
},
"lengthM": {
"type": "number"
},
"widthM": {
"type": "number"
},
"heightM": {
"type": "number"
},
"grossWeightKG": {
"type": "number"
},
"netWeightKG": {
"type": "number"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"ArticleImageGet": {
"required": [
"source"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
},
"packagingUnit": {
"$ref": "#/components/schemas/PackagingUnitDetail"
},
"source": {
"type": "string"
}
}
},
"ArticleImagePost": {
"required": [
"id"
],
"type": "object",
"properties": {
"id": {
"type": "string"
},
"packagingUnit": {
"$ref": "#/components/schemas/PackagingUnitDetail"
}
}
},
"ArticleImageUpload": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"uploadUrl": {
"type": "string"
}
}
},
"ArticleMinimumQuantityDetail": {
"required": [
"warehouseId"
],
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"calculationMode": {
"type": "string"
}
}
},
"ArticleMinimumShelfLifeDetail": {
"required": [
"minimumShelfLife",
"warehouseId"
],
"type": "object",
"properties": {
"minimumShelfLife": {
"minimum": 1,
"type": "integer",
"format": "int32"
},
"warehouseId": {
"type": "integer",
"format": "int64"
}
}
},
"ArticlePost": {
"required": [
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"articleType": {
"type": "string",
"enum": [
"PRODUCT",
"CARTON"
]
},
"barcode": {
"maxLength": 50,
"minLength": 0,
"type": "string"
},
"supplierReferenceNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"alternativeBarcodes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"lotRequired": {
"type": "boolean"
},
"expirationDateRequired": {
"type": "boolean"
},
"serialNumberRequired": {
"type": "boolean"
},
"canShipWithoutCarton": {
"type": "boolean"
},
"length": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"width": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"height": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"customsContentDescription": {
"type": "string"
},
"countryOfOrigin": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"salesPrice": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"insuranceValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"unNumber": {
"type": "string"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of article.",
"example": "{\"attr1\":\"val1\"}"
},
"itemGroup": {
"type": "string"
},
"lottableBatchRequired": {
"type": "boolean"
},
"alternativeNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringI18nDetail"
}
},
"tariffNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string"
},
"alternativeSalesPrices": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"alternativeInsuranceValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"alternativeCustomsValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"packagingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PackagingUnitDetail"
}
},
"lotNumberPriorities": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"minimumQuantities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumQuantityDetail"
}
},
"minimumExpirationDates": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MinimumExpirationDateDetail"
}
},
"minimumShelfLives": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ArticleMinimumShelfLifeDetail"
}
},
"dummyExpirationDate": {
"type": "string",
"format": "date-time"
},
"dummyLotNumber": {
"type": "string"
}
}
},
"AttachmentGet": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
},
"filename": {
"type": "string"
}
}
},
"AttachmentPost": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"filename": {
"type": "string"
}
}
},
"AttachmentPostResult": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"uploadUrl": {
"type": "string"
},
"mimeType": {
"type": "string"
}
}
},
"AuditGet": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"entityClass": {
"type": "string"
},
"entityId": {
"type": "integer",
"format": "int64"
},
"auditType": {
"type": "string",
"enum": [
"VALUE_CHANGE",
"ACTION",
"CREATE"
]
},
"auditHistories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditHistoryGet"
}
},
"created": {
"type": "string",
"format": "date-time"
}
}
},
"AuditHistoryGet": {
"type": "object",
"properties": {
"modifiedBy": {
"type": "string"
},
"data": {
"type": "string"
},
"auditType": {
"type": "string",
"enum": [
"VALUE_CHANGE",
"ACTION",
"CREATE"
]
},
"created": {
"type": "string",
"format": "date-time"
}
}
},
"BatchBookRequest": {
"required": [
"grossWeightKg",
"lineNumber",
"sellerId",
"shipTo",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"requestUUID": {
"type": "string",
"description": "A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.
This value is optional, if not included, a random requestUUID is generated."
},
"reference": {
"type": "string",
"description": "A human readable reference for the request.
This will be included in the mail that is sent once the operation completes.
This value is optional, if not included, a random reference will be generated."
},
"shippingServiceGroupId": {
"type": "integer",
"description": "shipping service group from which to load the shipping services to use.",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"lengthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional length (in meters) of the shipment."
},
"widthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional width (in meters) of the shipment."
},
"heightM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional height (in meters) of the shipment."
},
"grossWeightKg": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "The total weight (kilograms) of the shipment including packaging."
},
"shipTo": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"customsPositions": {
"type": "array",
"description": "Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.",
"items": {
"$ref": "#/components/schemas/CustomsPosition"
}
},
"sellerId": {
"type": "integer",
"description": "The seller who is booking this shipment (required).
The booked shipment will show up in the history of this seller.",
"format": "int64"
},
"invoiceNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The invoice number to be used for customs declaration."
},
"invoiceDate": {
"type": "string",
"description": "The invoice date to be used for customs declaration.",
"format": "date"
},
"transportInsuranceAmount": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional amount which should get insured when booking the shipment.
Note that most shipping services already have a basic insurance included. To use the already included insurance, you must not set this field to any value other than null.
Setting this field to a non null value will book an additional insurance."
},
"includeReturnLabel": {
"type": "boolean",
"description": "Optional value setting whether a return labels should be included in addition to the main label or not."
},
"trackingEnabled": {
"type": "boolean",
"description": "Optional value setting whether to turn on/off tracking functionality for shipment. Additional charges will apply when set to true."
},
"shipmentDate": {
"type": "string",
"description": "Optional future or today's date when the shipment will be handed over to the carrier. If not specified, default's to today.",
"format": "date"
},
"termsOfTrade": {
"type": "string",
"description": "Optional terms of trade. If not specified, default's DAP.",
"enum": [
"DAP",
"DDP"
]
},
"additionalParcels": {
"type": "array",
"description": "Optional additional parcels for the shipment. Note that by default the request represent the primary parcel/package for this shipment, use this field only if is needed to add more packages for the shipment.",
"items": {
"$ref": "#/components/schemas/ShipmentParcelGet"
}
},
"userIdentifier": {
"type": "string",
"description": "The userId of a third party app who booked the shipment."
},
"shopOrderIdentifier": {
"type": "string",
"description": "Optional value. Identifies the order in the customer's shop."
},
"contentDescription": {
"type": "string",
"description": "Optional description of the shipment contents."
},
"systemReference": {
"type": "string",
"description": "Optional system reference, can be used to trace the shipment"
},
"shipmentAttachments": {
"type": "array",
"description": "Optional attachments parameter",
"items": {
"$ref": "#/components/schemas/ShipmentAttachmentPost"
}
},
"cashOnDeliveryAmount": {
"type": "number",
"description": "Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment"
},
"cashOnDeliveryCurrency": {
"type": "string",
"description": "The currency in which COD amount is specified."
},
"lineNumber": {
"type": "integer",
"description": "The line number in the original file which the user uploaded as batch.
Note that the line number can be different than the index in the list of book requests, for example when there was a header in the original batch file.",
"format": "int32"
}
}
},
"BookBatchAsyncRequest": {
"required": [
"bookRequests",
"email",
"reference"
],
"type": "object",
"properties": {
"reference": {
"type": "string",
"description": "A human readable reference for the whole batch request.
This will be included in the mail that is sent once the operation completes."
},
"bookRequests": {
"type": "array",
"description": "List of book requests for the labels that need to be created.",
"items": {
"$ref": "#/components/schemas/BatchBookRequest"
}
},
"email": {
"type": "string",
"description": "The E-Mail address to which the ZIP File with the labels and export documents is sent."
}
}
},
"BookRequest": {
"required": [
"grossWeightKg",
"sellerId",
"shipTo",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"requestUUID": {
"type": "string",
"description": "A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.
This value is optional, if not included, a random requestUUID is generated."
},
"reference": {
"type": "string",
"description": "A human readable reference for the request.
This will be included in the mail that is sent once the operation completes.
This value is optional, if not included, a random reference will be generated."
},
"shippingServiceGroupId": {
"type": "integer",
"description": "shipping service group from which to load the shipping services to use.",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"lengthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional length (in meters) of the shipment."
},
"widthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional width (in meters) of the shipment."
},
"heightM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional height (in meters) of the shipment."
},
"grossWeightKg": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "The total weight (kilograms) of the shipment including packaging."
},
"shipTo": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"customsPositions": {
"type": "array",
"description": "Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.",
"items": {
"$ref": "#/components/schemas/CustomsPosition"
}
},
"sellerId": {
"type": "integer",
"description": "The seller who is booking this shipment (required).
The booked shipment will show up in the history of this seller.",
"format": "int64"
},
"invoiceNumber": {
"maxLength": 50,
"minLength": 1,
"type": "string",
"description": "The invoice number to be used for customs declaration."
},
"invoiceDate": {
"type": "string",
"description": "The invoice date to be used for customs declaration.",
"format": "date"
},
"transportInsuranceAmount": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional amount which should get insured when booking the shipment.
Note that most shipping services already have a basic insurance included. To use the already included insurance, you must not set this field to any value other than null.
Setting this field to a non null value will book an additional insurance."
},
"includeReturnLabel": {
"type": "boolean",
"description": "Optional value setting whether a return labels should be included in addition to the main label or not."
},
"trackingEnabled": {
"type": "boolean",
"description": "Optional value setting whether to turn on/off tracking functionality for shipment. Additional charges will apply when set to true."
},
"shipmentDate": {
"type": "string",
"description": "Optional future or today's date when the shipment will be handed over to the carrier. If not specified, default's to today.",
"format": "date"
},
"termsOfTrade": {
"type": "string",
"description": "Optional terms of trade. If not specified, default's DAP.",
"enum": [
"DAP",
"DDP"
]
},
"additionalParcels": {
"type": "array",
"description": "Optional additional parcels for the shipment. Note that by default the request represent the primary parcel/package for this shipment, use this field only if is needed to add more packages for the shipment.",
"items": {
"$ref": "#/components/schemas/ShipmentParcelGet"
}
},
"userIdentifier": {
"type": "string",
"description": "The userId of a third party app who booked the shipment."
},
"shopOrderIdentifier": {
"type": "string",
"description": "Optional value. Identifies the order in the customer's shop."
},
"contentDescription": {
"type": "string",
"description": "Optional description of the shipment contents."
},
"systemReference": {
"type": "string",
"description": "Optional system reference, can be used to trace the shipment"
},
"shipmentAttachments": {
"type": "array",
"description": "Optional attachments parameter",
"items": {
"$ref": "#/components/schemas/ShipmentAttachmentPost"
}
},
"cashOnDeliveryAmount": {
"type": "number",
"description": "Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment"
},
"cashOnDeliveryCurrency": {
"type": "string",
"description": "The currency in which COD amount is specified."
}
}
},
"BookResponse": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Indicates whether the operation was successful or not.",
"enum": [
"OK",
"ERROR"
]
},
"message": {
"type": "string",
"description": "Optional additional information about the operation's result.
When the operation failed, this field includes more information about the error."
},
"bookedShipmentId": {
"type": "integer",
"description": "ID of booked shipment",
"format": "int64"
},
"trackingNumber": {
"type": "string",
"description": "The tracking number of the booked shipment."
},
"trackingLink": {
"type": "string",
"description": "The tracking link of the booked shipment. Note that some carriers do not immediately recognize shipments after they have been created"
},
"labelUrls": {
"type": "array",
"description": "List of URLs where the labels can be downloaded.",
"items": {
"type": "string"
}
},
"documentUrls": {
"type": "array",
"description": "List of URLs where additional documents, such as export documents, can be downloaded.",
"items": {
"type": "string"
}
}
}
},
"BookReturnRequest": {
"required": [
"grossWeightKG",
"hash",
"reference",
"requestUUID",
"shipFrom"
],
"type": "object",
"properties": {
"requestUUID": {
"type": "string",
"description": "A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings. "
},
"hash": {
"maxLength": 2147483647,
"minLength": 1,
"type": "string",
"description": "The hash that is used for booking return label."
},
"reference": {
"type": "string",
"description": "A human readable reference for the request.
This will be included in the mail that is sent once the operation completes."
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"grossWeightKG": {
"type": "number",
"description": "Weight of the return shipment."
},
"heightM": {
"type": "number",
"description": "Height of the return shipment in meters."
},
"lengthM": {
"type": "number",
"description": "Length of the return shipment in meters."
},
"widthM": {
"type": "number",
"description": "Width of the return shipment in meters."
},
"customsPositions": {
"type": "array",
"description": "Optional customs positions for the shipment. Only required if shipping to countries for which export documents are required.",
"items": {
"$ref": "#/components/schemas/CustomsPosition"
}
},
"invoiceNumber": {
"type": "string",
"description": "Optional invoice number for the shipment. Only required for royal mail."
},
"invoiceDate": {
"type": "string",
"description": "Optional invoice date for the shipment. Only required for royal mail."
}
}
},
"BookShopAsyncRequest": {
"required": [
"mailTo",
"orderIdentifiers",
"parcelWeight",
"shippingServiceGroupId",
"shopId"
],
"type": "object",
"properties": {
"requestUUID": {
"type": "string",
"description": "A unique identifier for the request.
Used for tracing and to prevent duplicate shipment bookings.
This value is optional, if not included, a random requestUUID is generated."
},
"reference": {
"type": "string",
"description": "A human readable reference for the request.
This will be included in the mail that is sent once the operation completes.
This value is optional, if not included, a random reference will be generated."
},
"shippingServiceGroupId": {
"type": "integer",
"description": "shipping service group from which to load the shipping services to use.",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"lengthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional length (in meters) of the shipment."
},
"widthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional width (in meters) of the shipment."
},
"heightM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional height (in meters) of the shipment."
},
"mailTo": {
"type": "string",
"description": "e-Mail address to which the results will be sent.
Muliple e-mail addresses can be specified by separating them with a comma."
},
"shopId": {
"type": "integer",
"description": "ID of the shop from which the order data can be retrieved.",
"format": "int64"
},
"orderIdentifiers": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"description": "list of order identifiers for which the shipments need to get booked.
At least one order identifier needs to be specified.
Duplicate or empty order identifiers are not allowed.",
"items": {
"type": "string"
}
},
"parcelHeight": {
"minimum": 0,
"exclusiveMinimum": false,
"type": "number",
"description": "The height of the packaging material used in m.
Value is rounded to three decimal places."
},
"parcelWidth": {
"minimum": 0,
"exclusiveMinimum": false,
"type": "number",
"description": "The width of the packaging material used in m.
Value is rounded to three decimal places."
},
"parcelLength": {
"minimum": 0,
"exclusiveMinimum": false,
"type": "number",
"description": "The length of the packaging material used in m.
Value is rounded to three decimal places."
},
"parcelWeight": {
"minimum": 0,
"exclusiveMinimum": false,
"type": "number",
"description": "The weight of the packaging material used in kg.
Should not contain the weight of the shipment's content (eg: products)."
},
"contentWeight": {
"minimum": 0,
"exclusiveMinimum": false,
"type": "number",
"description": "Optional weight of the shipment's content in kg.
Should not contain the weight of the packaging material.
Use this field with care and in rare cases only, as it overrides the default weight calculation, which is based on the ordered product's weight.
Using this field can cause inconsistencies with the customs declaration and could result in errors during shipment booking."
},
"exportFulfillment": {
"type": "boolean",
"description": "If set to true, the fulfillment data (tracking number and provider) are transmitted to the shop system after the label was created."
},
"hideEmailAddress": {
"type": "boolean",
"description": "If set to true, the shipment recipient's e-mail address is not transmitted to the carrier.
This means that the carrier is not able to contact the recipient of the shipment by e-mail."
}
}
},
"BookedPickupGet": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"shippingServiceGroupId": {
"type": "integer",
"format": "int64"
},
"parcelCount": {
"type": "integer",
"format": "int32"
},
"pickupDate": {
"type": "string",
"format": "date"
},
"pickupFrom": {
"$ref": "#/components/schemas/ShipmentAddress"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"BookedShipmentGet": {
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"format": "int64"
},
"shippingServiceId": {
"type": "integer",
"format": "int64"
},
"request": {
"$ref": "#/components/schemas/ShippingOrderGet"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentDocumentGet"
}
},
"trackingDetails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingDetailGet"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"requestId": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"additionalTrackingNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalTrackingNumberGet"
}
},
"returnTrackingNumber": {
"type": "string"
},
"additionalReturnTrackingNumbers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AdditionalTrackingNumberGet"
}
},
"shipmentIdentifier": {
"type": "string"
},
"cancelledAt": {
"type": "string",
"format": "date-time"
},
"carrierCancelledAt": {
"type": "string",
"format": "date-time"
},
"shipTo": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"parcelWeight": {
"type": "number"
},
"parcelReference": {
"type": "string"
},
"contentDescription": {
"type": "string"
},
"trackingLink": {
"type": "string"
},
"returnTrackingLink": {
"type": "string"
},
"carrierSlug": {
"type": "string"
},
"carrierName": {
"type": "string"
},
"direction": {
"type": "string"
}
}
},
"BookedShipmentSummary": {
"type": "object",
"properties": {
"bookedShipmentId": {
"type": "integer",
"format": "int64"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"shippingServiceId": {
"type": "integer",
"format": "int64"
},
"trackingNumber": {
"type": "string"
},
"trackingLink": {
"type": "string"
},
"returnTrackingNumber": {
"type": "string"
},
"returnTrackingLink": {
"type": "string"
},
"shipmentIdentifier": {
"type": "string"
},
"reference": {
"type": "string"
},
"direction": {
"type": "string"
},
"shipToCountry": {
"type": "string"
},
"shipToZip": {
"type": "string"
},
"shipToCompany": {
"type": "string"
},
"shipToName1": {
"type": "string"
},
"shipToName2": {
"type": "string"
},
"carrierSlug": {
"type": "string"
},
"shipFromCountry": {
"type": "string"
},
"shipFromZip": {
"type": "string"
},
"shipFromCompany": {
"type": "string"
},
"shipFromName1": {
"type": "string"
},
"shipFromName2": {
"type": "string"
},
"weight": {
"type": "number",
"description": "The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment."
},
"volume": {
"type": "number",
"description": "The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment."
},
"lengthM": {
"type": "number",
"description": "Length of the shipment in meters."
},
"widthM": {
"type": "number",
"description": "Width of the shipment in meters."
},
"heightM": {
"type": "number",
"description": "Height of the shipment in meters."
},
"codAmount": {
"type": "number"
},
"codCurrency": {
"$ref": "#/components/schemas/Currency"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"trackingEnabled": {
"type": "boolean"
},
"userIdentifier": {
"type": "string"
},
"shipmentDate": {
"type": "string",
"format": "date"
},
"warehouseName": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"cancelledAt": {
"type": "string",
"format": "date-time"
},
"documents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentDocumentSummary"
}
},
"exportPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportPositionSummary"
}
}
}
},
"BundleGetDetail": {
"required": [
"sellerId",
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"bundleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleItemDetail"
}
},
"alternativeNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringI18nDetail"
}
},
"alternativeCustomsValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"sellerId": {
"type": "integer",
"format": "int64"
}
}
},
"BundleGetSummary": {
"required": [
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"bundleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleItemDetail"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"BundleItemDetail": {
"required": [
"articleId",
"quantity"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"quantity": {
"minimum": 1,
"type": "integer",
"format": "int32"
},
"unitCustomsValue": {
"type": "number"
},
"articleId": {
"type": "integer",
"format": "int64"
},
"articleSku": {
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
}
}
},
"BundlePost": {
"required": [
"sku"
],
"type": "object",
"properties": {
"sku": {
"maxLength": 50,
"minLength": 1,
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"alternativeSkus": {
"type": "array",
"items": {
"type": "string"
}
},
"name": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"customsValue": {
"$ref": "#/components/schemas/MonetaryValueDetail"
},
"bundleItems": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BundleItemDetail"
}
},
"alternativeNames": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StringI18nDetail"
}
},
"alternativeCustomsValues": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MonetaryValueDetail"
}
}
}
},
"CarrierGet": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
},
"carrierSlug": {
"type": "string"
}
}
},
"ContactGet": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"subscriptionType": {
"type": "string",
"enum": [
"ALL",
"CUSTOM",
"NOTHING"
]
},
"notificationSubscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationTypeDetail"
}
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"ContactPost": {
"type": "object",
"properties": {
"email": {
"type": "string"
},
"subscriptionType": {
"type": "string",
"enum": [
"ALL",
"CUSTOM",
"NOTHING"
]
},
"notificationSubscriptions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationTypeDetail"
}
},
"notificationCategories": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"ORDERS",
"RETURN_SHIPMENTS",
"ITEMS",
"INBOUNDS",
"CUSTOMER_INQUIRY",
"SHOPS",
"RETURN_LINK_LABEL",
"SHIPMENT_LABEL",
"INVENTORY",
"API_KEY_REQUESTS",
"IMPORTANT"
]
}
}
}
},
"CountryGet": {
"type": "object",
"properties": {
"iso2": {
"type": "string"
},
"iso3": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"Currency": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string"
},
"defaultFractionDigits": {
"type": "integer",
"format": "int32"
},
"numericCode": {
"type": "integer",
"format": "int32"
},
"symbol": {
"type": "string"
},
"displayName": {
"type": "string"
},
"numericCodeAsString": {
"type": "string"
}
}
},
"CurrencyExchangeRateGet": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"rate": {
"type": "number"
}
}
},
"CurrencyGet": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"name": {
"type": "string"
}
}
},
"CustomerExaminedRequest": {
"required": [
"customerExamined"
],
"type": "object",
"properties": {
"customerExamined": {
"type": "boolean"
}
}
},
"CustomerInquiryGet": {
"required": [
"sellerId",
"subject",
"warehouseId"
],
"type": "object",
"properties": {
"topic": {
"type": "string",
"description": "The topic of the Customer Inquiry.",
"enum": [
"ONBOARDING",
"FULFILMENT",
"SERVICE",
"ACCOUNTING",
"TECH_IT",
"MISCELLANEOUS_OTHER",
"REPORTS"
]
},
"category": {
"type": "string",
"description": "The category of the Customer Inquiry.",
"enum": [
"INBOUND",
"PICKING_AND_PACKING",
"SHIPMENT_AND_OUTBOUND",
"ARTICLES_ITEMS_IN_ORDER",
"DAMAGES",
"RETURNS",
"STOCK_DISCREPANCIES",
"CARRIER_PICKUPS",
"TRACKING_NUMBERS",
"MISCELLANEOUS_OTHER_FULFILLMENT",
"CARRIERS",
"INVESTIGATIONS",
"ACCOUNT_DETAILS_CHANGES",
"MAPPING_BUNDLES_FULFILMENT_PLANS",
"MISCELLANEOUS_OTHER_SERVICE",
"KEY_ACCOUNTS",
"NEW_SHOP",
"INVOICE_ENQUIRIES",
"REFUNDS_CREDIT_NOTES",
"SERVICE_REPORT_ENQUIRIES",
"SURCHARGES",
"INSURANCE_CUSTOMS",
"DUNNING",
"CARRIER_RELATED_CHARGES",
"CUSTOMS",
"ONBOARDING_FEE",
"DOUBLE_CHARGES_TRANSFERS",
"PAYMENT_METHODS",
"SEPA",
"PAYMENT_CONFIRMATIONS",
"SPECIAL_REQUESTS",
"MISCELLANEOUS_OTHER_ACCOUNTING",
"SYSTEM_ERRORS",
"SHOP_INTEGRATION",
"ADDING_USERS",
"CHANGES_IN_CONNECTOR_ACCOUNT",
"API_KEY_ROTATION",
"MISCELLANEOUS_OTHER_TECH_IT",
"SALES_ENQUIRY",
"TRANSPORT_ENQUIRY",
"ACCOUNT_DETAILS_CHANGE",
"MAPPING_BUNDLE_FULFILMENT_PLAN",
"CONTACTED_SALES_INSTEAD_OF_SERVICE",
"KEY_ACCOUNT",
"MISCELLANEOUS_OTHER",
"ONBOARDING_SELF_SIGNUP",
"OTHER_ONBOARDING_ISSUES",
"ARTICLE_WEIGHT_REPORT",
"CARTONAGE_REPORT",
"RETURNS_REPORT",
"BUNDLE_REPORT"
]
},
"subCategory": {
"type": "string",
"description": "The sub category of the Customer Inquiry.",
"enum": [
"FULFILMENT_WAREHOUSE",
"INSURANCE",
"CUSTOMS",
"LOST_ITEMS",
"DAMAGES",
"CARRIER_DISPUTES",
"MISCELLANEOUS_OTHER",
"SHIPPING_PRICES",
"OTHER_CHARGES"
]
},
"subject": {
"type": "string",
"description": "The subject of the Customer Inquiry."
},
"sellerId": {
"type": "integer",
"description": "The seller which initiated Customer Inquiry.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "The warehouse associated to the Customer Inquiry.",
"format": "int64"
},
"parentInquiryId": {
"type": "integer",
"description": "The Customer Inquiry on which this Customer Inquiry is based.
This field is optional.",
"format": "int64"
},
"metaInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Additional information for the Customer Inquiry.
This field is optional."
},
"messages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CustomerInquiryMessageGet"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"WITH_YOU",
"WITH_LOGSTA",
"RESOLVED"
]
},
"caseNumber": {
"type": "string"
},
"resolvedAt": {
"type": "string",
"format": "date-time"
},
"currentRating": {
"type": "number",
"format": "float"
},
"resolvedBy": {
"type": "string",
"enum": [
"LOGSTA",
"CLIENT"
]
}
}
},
"CustomerInquiryMessageGet": {
"type": "object",
"properties": {
"category": {
"type": "string",
"enum": [
"RATING_MESSAGE",
"INITIAL_MESSAGE",
"REOPEN_MESSAGE",
"LOGSTA_MESSAGE",
"CUSTOMER_MESSAGE",
"EXTERNAL_MESSAGE",
"LOGSTA_RESOLVE_MESSAGE",
"CUSTOMER_RESOLVE_MESSAGE",
"LOGSTA_REMINDER_MESSAGE",
"LAST_MESSAGE"
]
},
"created": {
"type": "string",
"format": "date-time"
},
"postedAt": {
"type": "string",
"format": "date-time"
},
"userEmail": {
"type": "string"
},
"username": {
"type": "string"
},
"fullName": {
"type": "string"
},
"metaInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AttachmentGet"
}
},
"message": {
"type": "string"
}
}
},
"CustomerInquiryMessagePost": {
"type": "object",
"properties": {
"message": {
"maxLength": 10000,
"minLength": 0,
"type": "string"
},
"attachments": {
"maxItems": 10,
"minItems": 0,
"type": "array",
"description": "Customer Inquiry Message attachments.
No more than 10 attachments allowed.",
"items": {
"$ref": "#/components/schemas/AttachmentPost"
}
}
}
},
"CustomerInquiryPost": {
"required": [
"messages",
"sellerId",
"subject",
"warehouseId"
],
"type": "object",
"properties": {
"topic": {
"type": "string",
"description": "The topic of the Customer Inquiry.",
"enum": [
"ONBOARDING",
"FULFILMENT",
"SERVICE",
"ACCOUNTING",
"TECH_IT",
"MISCELLANEOUS_OTHER",
"REPORTS"
]
},
"category": {
"type": "string",
"description": "The category of the Customer Inquiry.",
"enum": [
"INBOUND",
"PICKING_AND_PACKING",
"SHIPMENT_AND_OUTBOUND",
"ARTICLES_ITEMS_IN_ORDER",
"DAMAGES",
"RETURNS",
"STOCK_DISCREPANCIES",
"CARRIER_PICKUPS",
"TRACKING_NUMBERS",
"MISCELLANEOUS_OTHER_FULFILLMENT",
"CARRIERS",
"INVESTIGATIONS",
"ACCOUNT_DETAILS_CHANGES",
"MAPPING_BUNDLES_FULFILMENT_PLANS",
"MISCELLANEOUS_OTHER_SERVICE",
"KEY_ACCOUNTS",
"NEW_SHOP",
"INVOICE_ENQUIRIES",
"REFUNDS_CREDIT_NOTES",
"SERVICE_REPORT_ENQUIRIES",
"SURCHARGES",
"INSURANCE_CUSTOMS",
"DUNNING",
"CARRIER_RELATED_CHARGES",
"CUSTOMS",
"ONBOARDING_FEE",
"DOUBLE_CHARGES_TRANSFERS",
"PAYMENT_METHODS",
"SEPA",
"PAYMENT_CONFIRMATIONS",
"SPECIAL_REQUESTS",
"MISCELLANEOUS_OTHER_ACCOUNTING",
"SYSTEM_ERRORS",
"SHOP_INTEGRATION",
"ADDING_USERS",
"CHANGES_IN_CONNECTOR_ACCOUNT",
"API_KEY_ROTATION",
"MISCELLANEOUS_OTHER_TECH_IT",
"SALES_ENQUIRY",
"TRANSPORT_ENQUIRY",
"ACCOUNT_DETAILS_CHANGE",
"MAPPING_BUNDLE_FULFILMENT_PLAN",
"CONTACTED_SALES_INSTEAD_OF_SERVICE",
"KEY_ACCOUNT",
"MISCELLANEOUS_OTHER",
"ONBOARDING_SELF_SIGNUP",
"OTHER_ONBOARDING_ISSUES",
"ARTICLE_WEIGHT_REPORT",
"CARTONAGE_REPORT",
"RETURNS_REPORT",
"BUNDLE_REPORT"
]
},
"subCategory": {
"type": "string",
"description": "The sub category of the Customer Inquiry.",
"enum": [
"FULFILMENT_WAREHOUSE",
"INSURANCE",
"CUSTOMS",
"LOST_ITEMS",
"DAMAGES",
"CARRIER_DISPUTES",
"MISCELLANEOUS_OTHER",
"SHIPPING_PRICES",
"OTHER_CHARGES"
]
},
"subject": {
"type": "string",
"description": "The subject of the Customer Inquiry."
},
"sellerId": {
"type": "integer",
"description": "The seller which initiated Customer Inquiry.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "The warehouse associated to the Customer Inquiry.",
"format": "int64"
},
"parentInquiryId": {
"type": "integer",
"description": "The Customer Inquiry on which this Customer Inquiry is based.
This field is optional.",
"format": "int64"
},
"metaInfo": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Additional information for the Customer Inquiry.
This field is optional."
},
"messages": {
"type": "array",
"description": "Messages of the Customer Inquiry.",
"items": {
"$ref": "#/components/schemas/CustomerInquiryMessagePost"
}
}
}
},
"CustomerInquirySummary": {
"required": [
"sellerId",
"subject",
"warehouseId"
],
"type": "object",
"properties": {
"topic": {
"type": "string",
"description": "The topic of the Customer Inquiry.",
"enum": [
"ONBOARDING",
"FULFILMENT",
"SERVICE",
"ACCOUNTING",
"TECH_IT",
"MISCELLANEOUS_OTHER",
"REPORTS"
]
},
"category": {
"type": "string",
"description": "The category of the Customer Inquiry.",
"enum": [
"INBOUND",
"PICKING_AND_PACKING",
"SHIPMENT_AND_OUTBOUND",
"ARTICLES_ITEMS_IN_ORDER",
"DAMAGES",
"RETURNS",
"STOCK_DISCREPANCIES",
"CARRIER_PICKUPS",
"TRACKING_NUMBERS",
"MISCELLANEOUS_OTHER_FULFILLMENT",
"CARRIERS",
"INVESTIGATIONS",
"ACCOUNT_DETAILS_CHANGES",
"MAPPING_BUNDLES_FULFILMENT_PLANS",
"MISCELLANEOUS_OTHER_SERVICE",
"KEY_ACCOUNTS",
"NEW_SHOP",
"INVOICE_ENQUIRIES",
"REFUNDS_CREDIT_NOTES",
"SERVICE_REPORT_ENQUIRIES",
"SURCHARGES",
"INSURANCE_CUSTOMS",
"DUNNING",
"CARRIER_RELATED_CHARGES",
"CUSTOMS",
"ONBOARDING_FEE",
"DOUBLE_CHARGES_TRANSFERS",
"PAYMENT_METHODS",
"SEPA",
"PAYMENT_CONFIRMATIONS",
"SPECIAL_REQUESTS",
"MISCELLANEOUS_OTHER_ACCOUNTING",
"SYSTEM_ERRORS",
"SHOP_INTEGRATION",
"ADDING_USERS",
"CHANGES_IN_CONNECTOR_ACCOUNT",
"API_KEY_ROTATION",
"MISCELLANEOUS_OTHER_TECH_IT",
"SALES_ENQUIRY",
"TRANSPORT_ENQUIRY",
"ACCOUNT_DETAILS_CHANGE",
"MAPPING_BUNDLE_FULFILMENT_PLAN",
"CONTACTED_SALES_INSTEAD_OF_SERVICE",
"KEY_ACCOUNT",
"MISCELLANEOUS_OTHER",
"ONBOARDING_SELF_SIGNUP",
"OTHER_ONBOARDING_ISSUES",
"ARTICLE_WEIGHT_REPORT",
"CARTONAGE_REPORT",
"RETURNS_REPORT",
"BUNDLE_REPORT"
]
},
"subCategory": {
"type": "string",
"description": "The sub category of the Customer Inquiry.",
"enum": [
"FULFILMENT_WAREHOUSE",
"INSURANCE",
"CUSTOMS",
"LOST_ITEMS",
"DAMAGES",
"CARRIER_DISPUTES",
"MISCELLANEOUS_OTHER",
"SHIPPING_PRICES",
"OTHER_CHARGES"
]
},
"subject": {
"type": "string",
"description": "The subject of the Customer Inquiry."
},
"sellerId": {
"type": "integer",
"description": "The seller which initiated Customer Inquiry.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "The warehouse associated to the Customer Inquiry.",
"format": "int64"
},
"id": {
"type": "integer",
"format": "int64"
},
"status": {
"type": "string",
"enum": [
"WITH_YOU",
"WITH_LOGSTA",
"RESOLVED"
]
},
"created": {
"type": "string",
"format": "date-time"
},
"resolvedAt": {
"type": "string",
"format": "date-time"
},
"resolvedBy": {
"type": "string",
"enum": [
"LOGSTA",
"CLIENT"
]
},
"username": {
"type": "string"
},
"userEmail": {
"type": "string"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"CustomsPosition": {
"required": [
"description",
"pieceNetCustomsValue",
"pieceNetWeightKg",
"quantity"
],
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Name or short description of product."
},
"quantity": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "integer",
"description": "Number of pieces in shipment of product.",
"format": "int32"
},
"pieceNetWeightKg": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Net weight in kg per piece."
},
"pieceNetCustomsValue": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Net customs value per piece in the currency."
},
"originCountryIso2": {
"type": "string",
"description": "The country of origin of the product.",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"currency": {
"type": "string",
"description": "The currency in which customs values are specified."
},
"tariffNumber": {
"type": "string",
"description": "The tariff number (customs number)."
},
"orderedSku": {
"type": "string",
"description": "Optional value. The SKU of the position."
},
"unNumber": {
"type": "string",
"description": "Optional value. The UN number of the position."
}
}
},
"DashboardGet": {
"type": "object",
"properties": {
"graphs": {
"uniqueItems": true,
"type": "array",
"items": {
"$ref": "#/components/schemas/Graph"
}
}
}
},
"DashboardPost": {
"type": "object",
"properties": {
"graphs": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
}
}
},
"Data": {
"type": "object",
"properties": {
"slug": {
"type": "string"
},
"data": {
"type": "array",
"items": {
"type": "string"
}
},
"labels": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"DeliveryAddressDetail": {
"type": "object",
"properties": {
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"addressIdentifier": {
"type": "string"
},
"additionalIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderAddressAdditionalIdentifier"
}
},
"latitude": {
"type": "number",
"format": "double"
},
"longitude": {
"type": "number",
"format": "double"
}
}
},
"EndpointGet": {
"type": "object"
},
"EntityErrorDetail": {
"type": "object",
"properties": {
"errorCode": {
"type": "string"
},
"errorMessage": {
"type": "string"
}
}
},
"EntityErrorSummary": {
"type": "object",
"properties": {
"errorCode": {
"type": "string",
"description": "A machine-readable code identifying the nature of the error (e.g., 'OUT_OF_STOCK')."
},
"errorMessage": {
"type": "string",
"description": "A human-readable message explaining the error in detail."
}
},
"description": "Describes a high-level error that affects an entity (like an order), providing a specific error code and a human-readable error message."
},
"Error": {
"type": "object",
"properties": {
"graph": {
"type": "string"
},
"reason": {
"type": "string"
}
}
},
"EstimateRequest": {
"required": [
"estimateRequests"
],
"type": "object",
"properties": {
"estimateRequests": {
"type": "array",
"description": "Required list of estimate requests.
The value of requestUUID will be returned in the response, so it can be used to match the results to the requests.",
"items": {
"$ref": "#/components/schemas/BookRequest"
}
}
}
},
"EstimateResponse": {
"type": "object",
"properties": {
"estimateResults": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EstimateResult"
}
}
}
},
"EstimateResult": {
"type": "object",
"properties": {
"requestUUID": {
"type": "string"
},
"success": {
"type": "boolean"
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"amountLabel": {
"type": "number"
},
"amountInsurance": {
"type": "number"
}
}
},
"ExportPositionGet": {
"type": "object",
"properties": {
"currency": {
"$ref": "#/components/schemas/Currency"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"origin": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
},
"tariff": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"contentDescription": {
"type": "string"
},
"unNumber": {
"type": "string"
},
"description": {
"type": "string"
},
"pieceNetCustomsValue": {
"type": "number"
},
"pieceNetWeightKg": {
"type": "number"
}
}
},
"ExportPositionSummary": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"warehouseSku": {
"type": "string"
},
"unNumber": {
"type": "string"
}
}
},
"FilePostResult": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"uploadUrl": {
"type": "string"
}
}
},
"FulfillmentOrderDetail": {
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int64"
},
"warehouseName": {
"type": "string"
},
"fulfillmentOrderId": {
"type": "integer",
"format": "int64"
},
"fulfillmentOrderIdentifier": {
"type": "string"
},
"fulfillmentStatus": {
"type": "string"
},
"fulfillmentConnectorStatus": {
"type": "string"
},
"fulfillmentInStock": {
"type": "boolean"
},
"cancelled": {
"type": "boolean"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentOrderPositionDetail"
}
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentDetail"
}
},
"fulfillmentOrderCreated": {
"type": "string",
"format": "date-time"
},
"inPicking": {
"type": "boolean"
}
}
},
"FulfillmentOrderPositionDetail": {
"type": "object",
"properties": {
"fulfillmentOrderPositionId": {
"type": "integer",
"format": "int64"
},
"orderedSku": {
"type": "string"
},
"sku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"location": {
"type": "string"
},
"customsValue": {
"type": "number"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"fulfillmentOrderPositionIdentifier": {
"type": "string"
},
"bundleSku": {
"type": "string"
}
}
},
"FulfillmentOrderPositionSummary": {
"type": "object",
"properties": {
"fulfillmentOrderPositionId": {
"type": "integer",
"format": "int64",
"description": "The unique internal identifier for the fulfillment order position."
},
"orderedSku": {
"type": "string",
"description": "The SKU from the original order before any mapping or bundling."
},
"sku": {
"type": "string",
"description": "The final SKU selected for fulfillment, after considering bundles/maps."
},
"warehouseSku": {
"type": "string",
"description": "The SKU as known in the warehouse system."
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "The quantity of the item allocated for fulfillment."
},
"lot": {
"type": "string",
"description": "The lot number of the item allocated."
},
"location": {
"type": "string",
"description": "The warehouse location where the item is stored."
},
"customsValue": {
"type": "number",
"description": "The value of the item used for customs declaration."
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "The expiration date of the specific product batch used."
}
},
"description": "Details an individual product position within a fulfillment order, including its allocated quantity, lot, location, and expiration date."
},
"FulfillmentOrderSummary": {
"type": "object",
"properties": {
"fulfillmentOrderIdentifier": {
"type": "string",
"description": "The unique identifier for the fulfillment order in the warehouse system."
},
"fulfillmentStatus": {
"type": "string",
"description": "The current status of the fulfillment order (e.g., 'READY_FOR_PICKING', 'SHIPPED')."
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentOrderPositionSummary"
},
"description": "Details of the items and quantities processed in this fulfillment order."
},
"shipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentSummary"
},
"description": "A list of shipments created as a result of this fulfillment order."
}
},
"description": "Provides an overview of a planned fulfillment operation, detailing its unique identifier, current status in the warehouse, the inventory positions assigned to it, and any resulting shipments."
},
"Graph": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"GroupedInboundShipmentPosition": {
"type": "object",
"properties": {
"warehouseSku": {
"type": "string"
},
"sellerSku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
}
}
},
"GroupedReturnShipmentPositionDetail": {
"type": "object",
"properties": {
"sellerSku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"name": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
}
},
"classCode": {
"type": "string"
},
"classDescription": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"reasonDescription": {
"type": "string"
}
}
},
"GroupedReturnShipmentPositionSummary": {
"type": "object",
"properties": {
"sellerSku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"name": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"classCode": {
"type": "string"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
}
},
"reasonCode": {
"type": "string"
},
"reasonDescription": {
"type": "string"
},
"classDescription": {
"type": "string"
}
}
},
"GroupedShipmentPositionDetail": {
"type": "object",
"properties": {
"warehouseSku": {
"type": "string"
},
"sellerSku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
}
}
}
},
"HandlingUnitDetail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PALLET",
"CARTON",
"HALF_PALLET",
"ORDER",
"TRUCK"
]
},
"sscc": {
"type": "string"
},
"carrier": {
"type": "string"
},
"tracking": {
"type": "string"
},
"handlingUnitIdentifier": {
"type": "string"
},
"truckHandlingUnitIdentifier": {
"type": "string"
},
"handlingPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlingUnitPositionDetail"
}
},
"childHandlingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlingUnitDetail"
}
}
}
},
"HandlingUnitPositionDetail": {
"type": "object",
"properties": {
"sscc": {
"type": "string"
},
"positionIdentifier": {
"type": "string"
},
"sku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
}
}
},
"InboundCommentGet": {
"type": "object",
"properties": {
"commentText": {
"type": "string"
},
"reasonToAddImages": {
"type": "string"
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundImageGet"
}
}
}
},
"InboundDeliveryInfoDetail": {
"required": [
"cargoType",
"quantity"
],
"type": "object",
"properties": {
"cargoType": {
"type": "string",
"description": "Cargo type.",
"enum": [
"CARTON",
"PALLET",
"CONTAINER"
]
},
"quantity": {
"minimum": 1,
"type": "integer",
"description": "Cargo quantity.",
"format": "int32"
}
}
},
"InboundGet": {
"required": [
"deliverySlipNumber",
"estimatedArrivalTime",
"sellerId",
"shipFrom",
"shopId",
"warehouseId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "Warehouse ID.
A list of warehouse identifiers and names can be obtained by executing GET /warehouses",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressDetail"
},
"estimatedArrivalTime": {
"type": "string",
"description": "Estimated date of arrival",
"format": "date-time"
},
"deliverySlipNumber": {
"type": "string",
"description": "Delivery slip number"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional custom attributes of this inbound.",
"example": "{\"attr1\":\"val1\"}"
},
"movementReferenceNumber": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU"
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"inboundIdentifier": {
"type": "string"
},
"exportedAt": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"cancelledAt": {
"type": "string",
"format": "date-time"
},
"inboundStatus": {
"type": "string",
"enum": [
"PENDING",
"CREATED",
"PROCESSING",
"COMPLETED",
"CANCELLED"
]
},
"requestId": {
"type": "string"
},
"inboundShipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundShipmentDetail"
}
},
"createdByLogsta": {
"type": "boolean"
},
"trackingNumber": {
"type": "string"
},
"comments": {
"type": "string"
},
"deliverySlipDate": {
"type": "string",
"format": "date-time"
},
"externalIdentifier": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"inboundReference": {
"type": "string"
},
"shopId": {
"type": "integer",
"description": "Shop ID.",
"format": "int64"
},
"carrier": {
"type": "string"
},
"trackingLink": {
"type": "string"
},
"inboundPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundPositionDetailGet"
}
},
"deliveryInfo": {
"$ref": "#/components/schemas/InboundDeliveryInfoDetail"
}
}
},
"InboundImageGet": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
}
}
},
"InboundPositionDetailGet": {
"required": [
"quantity",
"sku"
],
"type": "object",
"properties": {
"quantity": {
"minimum": 1,
"type": "integer",
"description": "Number of units of the position.",
"format": "int32"
},
"sku": {
"type": "string",
"description": "Position SKU."
},
"lot": {
"type": "string",
"description": "Optional position lot."
},
"location": {
"type": "string",
"description": "Optional position location."
},
"expirationDate": {
"type": "string",
"description": "Optional position expiration date.",
"format": "date"
},
"serialNumbers": {
"type": "array",
"description": "Optional position serial numbers.",
"items": {
"type": "string"
}
},
"positionNumber": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "Optional position number or identifier"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"inboundPositionId": {
"type": "integer",
"format": "int64"
},
"warehouseSku": {
"type": "string"
},
"articleIdentifier": {
"type": "string"
},
"productIdentifier": {
"type": "string"
}
}
},
"InboundPositionDetailPost": {
"required": [
"quantity",
"sku"
],
"type": "object",
"properties": {
"quantity": {
"minimum": 1,
"type": "integer",
"description": "Number of units of the position.",
"format": "int32"
},
"sku": {
"type": "string",
"description": "Position SKU."
},
"lot": {
"type": "string",
"description": "Optional position lot."
},
"location": {
"type": "string",
"description": "Optional position location."
},
"expirationDate": {
"type": "string",
"description": "Optional position expiration date.",
"format": "date"
},
"serialNumbers": {
"type": "array",
"description": "Optional position serial numbers.",
"items": {
"type": "string"
}
},
"positionNumber": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "Optional position number or identifier"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional custom attributes of this inbound position.",
"example": "{\"attr1\":\"val1\"}"
}
}
},
"InboundPositionSummary": {
"type": "object",
"properties": {
"inboundPositionId": {
"type": "integer",
"format": "int64"
},
"sku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"articleIdentifier": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"InboundPost": {
"required": [
"deliveryInfo",
"deliverySlipNumber",
"estimatedArrivalTime",
"inboundPositions",
"sellerId",
"shipFrom",
"trackingNumber",
"warehouseId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "Warehouse ID.
A list of warehouse identifiers and names can be obtained by executing GET /warehouses",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressDetail"
},
"estimatedArrivalTime": {
"type": "string",
"description": "Estimated date of arrival",
"format": "date-time"
},
"deliverySlipNumber": {
"type": "string",
"description": "Delivery slip number"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional custom attributes of this inbound.",
"example": "{\"attr1\":\"val1\"}"
},
"movementReferenceNumber": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU"
},
"inboundPositions": {
"type": "array",
"description": "List of inbound positions",
"items": {
"$ref": "#/components/schemas/InboundPositionDetailPost"
}
},
"deliveryInfo": {
"$ref": "#/components/schemas/InboundDeliveryInfoDetail"
},
"trackingNumber": {
"type": "string",
"description": "Optional tracking number"
},
"carrier": {
"type": "string",
"description": "Optional carrier"
},
"comments": {
"type": "string",
"description": "Comments."
},
"deliverySlipDate": {
"type": "string",
"description": "Optional date of the creation of the delivery slip",
"format": "date-time"
},
"externalIdentifier": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "Optional identifier. Can be a freight number or container number"
},
"tags": {
"type": "array",
"description": "Optional tags of this inbound",
"items": {
"type": "string"
}
},
"inboundReference": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "Optional additional reference of this Inbound."
}
}
},
"InboundPostResult": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"inboundId": {
"type": "integer",
"format": "int64"
},
"field": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"InboundShipmentDetail": {
"type": "object",
"properties": {
"inboundShipmentIdentifier": {
"type": "string"
},
"arrivedAt": {
"type": "string",
"format": "date-time"
},
"inboundShipmentPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundShipmentPositionDetail"
}
},
"comments": {
"type": "string"
},
"reasonToAddImages": {
"type": "string"
},
"totalGrossWeight": {
"type": "number"
},
"inboundComments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundCommentGet"
}
},
"images": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundImageGet"
}
},
"groupedInboundShipmentPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedInboundShipmentPosition"
}
}
}
},
"InboundShipmentPositionDetail": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"warehouseSku": {
"type": "string"
},
"sellerSku": {
"type": "string"
},
"lot": {
"type": "string"
},
"location": {
"type": "string"
},
"positionIdentifier": {
"type": "string"
},
"totalGrossWeight": {
"type": "number"
},
"barcode": {
"type": "string"
},
"storageCode": {
"type": "string"
},
"storageBlocked": {
"type": "boolean"
},
"expirationDate": {
"type": "string",
"format": "date"
}
}
},
"InboundShipmentPositionSummary": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"warehouseSku": {
"type": "string"
},
"lot": {
"type": "string"
},
"positionIdentifier": {
"type": "string"
},
"location": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date"
}
}
},
"InboundShipmentSummary": {
"type": "object",
"properties": {
"inboundShipmentIdentifier": {
"type": "string"
},
"arrivedAt": {
"type": "string",
"format": "date-time"
},
"inboundShipmentPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundShipmentPositionSummary"
}
},
"totalGrossWeight": {
"type": "number"
}
}
},
"InboundSummary": {
"required": [
"deliverySlipNumber",
"estimatedArrivalTime",
"sellerId",
"shipFrom",
"warehouseId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "Warehouse ID.
A list of warehouse identifiers and names can be obtained by executing GET /warehouses",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressDetail"
},
"estimatedArrivalTime": {
"type": "string",
"description": "Estimated date of arrival",
"format": "date-time"
},
"deliverySlipNumber": {
"type": "string",
"description": "Delivery slip number"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional custom attributes of this inbound.",
"example": "{\"attr1\":\"val1\"}"
},
"movementReferenceNumber": {
"maxLength": 1024,
"minLength": 0,
"type": "string",
"description": "Optional movement reference number. Unique identifier assigned to customs declarations within the UK and EU"
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"cancelledAt": {
"type": "string",
"format": "date-time"
},
"inboundIdentifier": {
"type": "string"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"trackingLink": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"carrier": {
"type": "string"
},
"createdByLogsta": {
"type": "boolean"
},
"inboundStatus": {
"type": "string",
"enum": [
"PENDING",
"CREATED",
"PROCESSING",
"COMPLETED",
"CANCELLED"
]
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"inboundPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundPositionSummary"
}
},
"inboundShipments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/InboundShipmentSummary"
}
},
"deliveryInfo": {
"$ref": "#/components/schemas/InboundDeliveryInfoDetail"
}
}
},
"InputStream": {
"type": "object"
},
"ItemHistoryInventoryBase": {
"type": "object",
"properties": {
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"expiration": {
"type": "string",
"format": "date-time"
},
"locationBlocked": {
"type": "boolean"
}
}
},
"ItemHistorySummary": {
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int64"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"itemId": {
"type": "integer",
"format": "int64"
},
"warehouseSku": {
"type": "string"
},
"name": {
"type": "string"
},
"sellerSku": {
"type": "string"
},
"barcode": {
"type": "string"
},
"inventory": {
"type": "integer",
"format": "int32"
},
"reserved": {
"type": "integer",
"format": "int32"
},
"eventDate": {
"type": "string",
"format": "date-time"
},
"itemHistoryInventories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemHistoryInventoryBase"
}
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"ItemInfo": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"sellerSku": {
"type": "string"
},
"name": {
"type": "string"
},
"barcode": {
"type": "string"
},
"countryOfOrigin": {
"type": "string"
},
"tariffNumber": {
"type": "string"
},
"sellerIdentifier": {
"type": "string"
},
"lotRequired": {
"type": "boolean"
},
"restrictedShipping": {
"type": "boolean"
},
"weight": {
"type": "number"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"inventory": {
"type": "integer",
"format": "int32"
},
"inbound": {
"type": "integer",
"format": "int32"
},
"reserved": {
"type": "integer",
"format": "int32"
},
"articleDeletedAt": {
"type": "string",
"format": "date-time"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"itemId": {
"type": "integer",
"format": "int64"
},
"itemInventories": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemInventoryInfo"
}
},
"expirationDateRequired": {
"type": "boolean"
},
"serialNumberRequired": {
"type": "boolean"
},
"canShipWithoutCarton": {
"type": "boolean"
},
"articleId": {
"type": "integer",
"format": "int64"
},
"articleIdentifier": {
"type": "string"
},
"articleType": {
"type": "string",
"enum": [
"PRODUCT",
"CARTON"
]
},
"articleName": {
"$ref": "#/components/schemas/StringI18nDetail"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"ItemInventoryInfo": {
"type": "object",
"properties": {
"lot": {
"type": "string"
},
"expiration": {
"type": "string",
"format": "date-time"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"locationBlocked": {
"type": "boolean"
},
"storage": {
"type": "string"
},
"location": {
"type": "string"
},
"blockedReason": {
"type": "string"
}
}
},
"ItemMovementGet": {
"type": "object",
"properties": {
"movementDate": {
"type": "string",
"format": "date"
},
"warehouseIdentifier": {
"type": "string"
},
"reference": {
"type": "string"
},
"adjustmentQuantity": {
"type": "integer",
"format": "int32"
}
}
},
"ItemMovements": {
"type": "object",
"properties": {
"warehouseName": {
"type": "string"
},
"itemMovements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ItemMovementGet"
}
}
}
},
"JsonNode": {
"type": "object",
"properties": {
"float": {
"type": "boolean"
},
"short": {
"type": "boolean"
},
"nodeType": {
"type": "string",
"enum": [
"ARRAY",
"BINARY",
"BOOLEAN",
"MISSING",
"NULL",
"NUMBER",
"OBJECT",
"POJO",
"STRING"
]
},
"number": {
"type": "boolean"
},
"double": {
"type": "boolean"
},
"binary": {
"type": "boolean"
},
"integralNumber": {
"type": "boolean"
},
"boolean": {
"type": "boolean"
},
"long": {
"type": "boolean"
},
"int": {
"type": "boolean"
},
"valueNode": {
"type": "boolean"
},
"containerNode": {
"type": "boolean"
},
"missingNode": {
"type": "boolean"
},
"object": {
"type": "boolean"
},
"pojo": {
"type": "boolean"
},
"floatingPointNumber": {
"type": "boolean"
},
"bigDecimal": {
"type": "boolean"
},
"bigInteger": {
"type": "boolean"
},
"textual": {
"type": "boolean"
},
"array": {
"type": "boolean"
},
"null": {
"type": "boolean"
}
}
},
"LanguageGet": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"nativeName": {
"type": "string"
},
"isoCode": {
"type": "string"
}
}
},
"LengthMeasurementDetail": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"unit": {
"type": "string",
"enum": [
"M",
"DM",
"CM",
"MM",
"IN"
]
}
}
},
"Link": {
"type": "object",
"properties": {
"link": {
"type": "string"
}
}
},
"LinkRequest": {
"type": "object",
"properties": {
"token": {
"type": "string"
}
}
},
"LogoUpload": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"description": "File key which should be used for uploading the file and adding the logo image"
},
"uploadUrl": {
"type": "string",
"description": "URL for uploading the logo image"
},
"mimeType": {
"type": "string",
"description": "Mimetype of the logo image"
}
}
},
"MessageDetail": {
"type": "object",
"properties": {
"code": {
"type": "string"
},
"description": {
"type": "string"
}
}
},
"MfaPreferenceRequest": {
"required": [
"mfaOptions"
],
"type": "object",
"properties": {
"mfaOptions": {
"type": "array",
"items": {
"type": "string",
"enum": [
"EMAIL",
"SOFTWARE_TOKEN"
]
}
},
"preferredMfa": {
"type": "string"
}
}
},
"MinimumExpirationDateDetail": {
"required": [
"notifyDaysBeforeExpiration",
"warehouseId"
],
"type": "object",
"properties": {
"notifyDaysBeforeExpiration": {
"minimum": 1,
"type": "integer",
"format": "int32"
},
"warehouseId": {
"type": "integer",
"format": "int64"
}
}
},
"MonetaryValueDetail": {
"type": "object",
"properties": {
"currencyCode": {
"type": "string"
},
"value": {
"type": "number"
}
}
},
"NotificationAcknowledgementDTO": {
"type": "object",
"properties": {
"username": {
"type": "string"
},
"seenAt": {
"type": "string",
"format": "date-time"
}
}
},
"NotificationContentDTO": {
"required": [
"language",
"title"
],
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"DE",
"EN",
"ES",
"PT",
"FR",
"IT",
"ZH"
]
},
"title": {
"type": "string"
}
}
},
"NotificationContentDetailDTO": {
"required": [
"language",
"message",
"title"
],
"type": "object",
"properties": {
"language": {
"type": "string",
"enum": [
"DE",
"EN",
"ES",
"PT",
"FR",
"IT",
"ZH"
]
},
"title": {
"type": "string"
},
"message": {
"type": "string"
}
}
},
"NotificationDetail": {
"type": "object"
},
"NotificationDetailImportantAdmin": {
"required": [
"contents",
"expiresAt",
"severityLevel",
"status"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"hash": {
"type": "string"
},
"message": {
"type": "string"
},
"lastOccurrence": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"severityLevel": {
"type": "string",
"enum": [
"INFO",
"WARNING",
"ERROR",
"URGENT",
"UPDATES"
]
},
"notificationType": {
"type": "string",
"enum": [
"UNKNOWN_SKU_IN_ORDER",
"ORDER_CANCELLATION_FAILED",
"AMAZON_PARTNERED_CARRIER",
"INVALID_ORDER_IDENTIFIER",
"MISSING_ORDER_INFORMATION",
"COMPLETING_ORDER_FORCEFULLY",
"ADDRESS_VERIFICATION_FAILED",
"ORDERS_OUT_OF_STOCK",
"RESTRICTIVE_SHIPMENT",
"NEW_RETURN",
"STOCK_BELOW_THRESHOLD",
"MULTIPLE_STOCK_QUANT_IDS",
"ITEM_NOT_STOCKED_AT_SHOP",
"INBOUND_COMPLETED",
"INBOUND_SHIPMENT_ARRIVED",
"INBOUND_STATUS_CHANGE",
"INBOUND_UNKNOWN_SKU",
"INBOUND_INFORMATION_MISSING",
"CUSTOMER_INQUIRY_UPDATE",
"CUSTOMER_INQUIRY_RESOLVED",
"INQUIRY_REMINDER",
"CUSTOMER_INQUIRY_NEW_QUIVO",
"CUSTOMER_INQUIRY_NEW",
"SHOP_ERROR",
"ITEM_NOT_FOUND",
"SHOP_DEACTIVATED",
"NOT_ENOUGH_ACCESS",
"LOCATION_NOT_FOUND",
"MULTIPLE_LOCATION_IDS",
"NO_LOCATION_CONFIGURED",
"IMPORTING_ORDERS_FAILED",
"EXPORTING_INVENTORY_FAILED",
"SHOP_NOT_CONFIGURED_PROPERLy",
"SHOP_AVAILABLE",
"NEW_RETURN_LINK_LABEL",
"ITEM_EXPIRATION",
"APPROVED_API_KEY_REQUEST",
"EXPIRED_API_KEY",
"DECLINED_API_KEY_REQUEST",
"DELETED_API_KEY_REQUEST",
"IMPORTANT_NOTIFICATION"
]
},
"contents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationContentDetailDTO"
}
},
"status": {
"type": "string",
"enum": [
"DRAFT",
"PUBLISHED",
"DELETED"
]
},
"expiresAt": {
"type": "string",
"format": "date-time"
},
"legalEntityIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"subscriptionPackages": {
"type": "array",
"items": {
"type": "string",
"enum": [
"RISING_STAR",
"STELLAR_EXPLORER",
"FULFILLED_LEGEND",
"WITHOUT_PACKAGE",
"SEND_IT_YOURSELF",
"CUSTOMIZED"
]
}
},
"userRoles": {
"type": "array",
"items": {
"type": "string",
"enum": [
"ROLE_ADMIN",
"ROLE_LOCAL_ADMIN",
"ROLE_SELLER_ADMIN",
"ROLE_USER",
"ROLE_MOBILE_APP",
"ROLE_WEBHOOK"
]
}
},
"usernames": {
"type": "array",
"items": {
"type": "string"
}
},
"sellerIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"acknowledgements": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationAcknowledgementDTO"
}
},
"channel": {
"type": "string",
"enum": [
"EMAIL",
"POP_UP",
"BOTH"
]
}
}
},
"NotificationSummary": {
"required": [
"severityLevel"
],
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"hash": {
"type": "string"
},
"message": {
"type": "string"
},
"lastOccurrence": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"severityLevel": {
"type": "string",
"enum": [
"INFO",
"WARNING",
"ERROR",
"URGENT",
"UPDATES"
]
},
"notificationType": {
"type": "string",
"enum": [
"UNKNOWN_SKU_IN_ORDER",
"ORDER_CANCELLATION_FAILED",
"AMAZON_PARTNERED_CARRIER",
"INVALID_ORDER_IDENTIFIER",
"MISSING_ORDER_INFORMATION",
"COMPLETING_ORDER_FORCEFULLY",
"ADDRESS_VERIFICATION_FAILED",
"ORDERS_OUT_OF_STOCK",
"RESTRICTIVE_SHIPMENT",
"NEW_RETURN",
"STOCK_BELOW_THRESHOLD",
"MULTIPLE_STOCK_QUANT_IDS",
"ITEM_NOT_STOCKED_AT_SHOP",
"INBOUND_COMPLETED",
"INBOUND_SHIPMENT_ARRIVED",
"INBOUND_STATUS_CHANGE",
"INBOUND_UNKNOWN_SKU",
"INBOUND_INFORMATION_MISSING",
"CUSTOMER_INQUIRY_UPDATE",
"CUSTOMER_INQUIRY_RESOLVED",
"INQUIRY_REMINDER",
"CUSTOMER_INQUIRY_NEW_QUIVO",
"CUSTOMER_INQUIRY_NEW",
"SHOP_ERROR",
"ITEM_NOT_FOUND",
"SHOP_DEACTIVATED",
"NOT_ENOUGH_ACCESS",
"LOCATION_NOT_FOUND",
"MULTIPLE_LOCATION_IDS",
"NO_LOCATION_CONFIGURED",
"IMPORTING_ORDERS_FAILED",
"EXPORTING_INVENTORY_FAILED",
"SHOP_NOT_CONFIGURED_PROPERLy",
"SHOP_AVAILABLE",
"NEW_RETURN_LINK_LABEL",
"ITEM_EXPIRATION",
"APPROVED_API_KEY_REQUEST",
"EXPIRED_API_KEY",
"DECLINED_API_KEY_REQUEST",
"DELETED_API_KEY_REQUEST",
"IMPORTANT_NOTIFICATION"
]
},
"contents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationContentDTO"
}
}
}
},
"NotificationTypeDetail": {
"type": "object",
"properties": {
"type": {
"type": "string"
},
"category": {
"type": "string"
}
}
},
"OrderAddressAdditionalIdentifier": {
"type": "object",
"properties": {
"identifier": {
"type": "string",
"description": "The specific identifier string (e.g., a GLN or store ID)."
},
"type": {
"type": "string",
"description": "The type of the identifier (e.g., 'GLN', 'SHOP_SPECIFIC')."
}
},
"description": "Represents an additional, specialized identifier for an address, such as a GLN or a shop-specific ID, along with its type."
},
"OrderAttachmentGet": {
"required": [
"attachmentPlacement",
"copyCount",
"printerType"
],
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Name for the attachment. This name will be displayed in the attachments section for the given order"
},
"printerType": {
"type": "string",
"description": "Printer type, which should be used for printing the document in the warehouse",
"enum": [
"LABEL_PRINTER",
"DOCUMENT_PRINTER",
"DOCUMENT_PRINTER_2_A6",
"DOCUMENT_PRINTER_2_FOLIO"
]
},
"attachmentPlacement": {
"type": "string",
"description": "Where the attached document should be placed in regard to the parcel",
"enum": [
"INSIDE_PACKAGE",
"OUTSIDE_PACKAGE"
]
},
"copyCount": {
"minimum": 1,
"type": "integer",
"description": "Number of times the attachment should be printed per shipment",
"format": "int32"
},
"printingType": {
"type": "string",
"description": "If the attached document should be printed per order or per shipment",
"enum": [
"ORDER",
"SHIPMENT"
]
},
"fileKey": {
"type": "string"
},
"mimeType": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"url": {
"$ref": "#/components/schemas/Link"
}
}
},
"OrderAttachmentPost": {
"required": [
"attachmentPlacement",
"copyCount",
"printerType"
],
"type": "object",
"properties": {
"filename": {
"type": "string",
"description": "Name for the attachment. This name will be displayed in the attachments section for the given order"
},
"printerType": {
"type": "string",
"description": "Printer type, which should be used for printing the document in the warehouse",
"enum": [
"LABEL_PRINTER",
"DOCUMENT_PRINTER",
"DOCUMENT_PRINTER_2_A6",
"DOCUMENT_PRINTER_2_FOLIO"
]
},
"attachmentPlacement": {
"type": "string",
"description": "Where the attached document should be placed in regard to the parcel",
"enum": [
"INSIDE_PACKAGE",
"OUTSIDE_PACKAGE"
]
},
"copyCount": {
"minimum": 1,
"type": "integer",
"description": "Number of times the attachment should be printed per shipment",
"format": "int32"
},
"printingType": {
"type": "string",
"description": "If the attached document should be printed per order or per shipment",
"enum": [
"ORDER",
"SHIPMENT"
]
},
"fileKey": {
"type": "string",
"description": "Identifier of the file to be attached."
},
"mimeType": {
"type": "string",
"description": "Mime type of the file"
}
}
},
"OrderAttachmentSupportProvider": {
"type": "object"
},
"OrderAttachmentUpload": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"description": "File key which should be used for uploading the file and adding the attachment"
},
"uploadUrl": {
"type": "string",
"description": "URL for uploading the attachment"
},
"mimeType": {
"type": "string",
"description": "Mimetype of the attachment"
}
}
},
"OrderConfirmFulfillment": {
"type": "object",
"properties": {
"fulfillmentConfirmed": {
"type": "boolean",
"description": "Optional value to prioritize order."
}
}
},
"OrderDetail": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"orderIdentifier": {
"type": "string"
},
"orderReference": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderDate": {
"type": "string",
"format": "date-time"
},
"exportedAt": {
"type": "string",
"format": "date-time"
},
"cancelRequestedAt": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"customerIdentifier": {
"type": "string"
},
"customerPurchaseOrderNumber": {
"type": "string"
},
"ssccLabel": {
"type": "boolean"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"sellerName": {
"type": "string"
},
"shopAvailableAt": {
"type": "string"
},
"shopActive": {
"type": "boolean"
},
"shopId": {
"type": "integer",
"format": "int64"
},
"shopSystem": {
"type": "string"
},
"shopSystemName": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/components/schemas/DeliveryAddressDetail"
},
"invoiceAddress": {
"$ref": "#/components/schemas/AddressDetail"
},
"currency": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PositionDetail"
}
},
"fulfillmentOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentOrderDetail"
}
},
"handlingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlingUnitDetail"
}
},
"earliestDeliveryDate": {
"type": "string",
"format": "date"
},
"latestDeliveryDate": {
"type": "string",
"format": "date"
},
"comment": {
"type": "string"
},
"transportInsuranceAmount": {
"type": "number"
},
"cashOnDeliveryAmount": {
"type": "number"
},
"cashOnDeliveryCurrency": {
"type": "string"
},
"deliveryInstruction": {
"type": "string"
},
"shippingMethodIdentifier": {
"type": "string"
},
"shippingMethodName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"earliestShipDate": {
"type": "string",
"format": "date"
},
"latestShipDate": {
"type": "string",
"format": "date"
},
"piiDataRemoved": {
"type": "boolean"
},
"paymentType": {
"type": "string"
},
"trackingEnabled": {
"type": "boolean"
},
"orderPriority": {
"type": "integer",
"format": "int32"
},
"fulfillmentConfirmed": {
"type": "boolean"
},
"entityErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityErrorDetail"
}
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
}
}
},
"OrderDetailWithAttachments": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"orderIdentifier": {
"type": "string"
},
"orderReference": {
"type": "string"
},
"orderStatus": {
"type": "string"
},
"orderDate": {
"type": "string",
"format": "date-time"
},
"exportedAt": {
"type": "string",
"format": "date-time"
},
"cancelRequestedAt": {
"type": "string",
"format": "date-time"
},
"completedAt": {
"type": "string",
"format": "date-time"
},
"customerIdentifier": {
"type": "string"
},
"customerPurchaseOrderNumber": {
"type": "string"
},
"ssccLabel": {
"type": "boolean"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"sellerName": {
"type": "string"
},
"shopAvailableAt": {
"type": "string"
},
"shopActive": {
"type": "boolean"
},
"shopId": {
"type": "integer",
"format": "int64"
},
"shopSystem": {
"type": "string"
},
"shopSystemName": {
"type": "string"
},
"deliveryAddress": {
"$ref": "#/components/schemas/DeliveryAddressDetail"
},
"invoiceAddress": {
"$ref": "#/components/schemas/AddressDetail"
},
"currency": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PositionDetail"
}
},
"fulfillmentOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentOrderDetail"
}
},
"handlingUnits": {
"type": "array",
"items": {
"$ref": "#/components/schemas/HandlingUnitDetail"
}
},
"earliestDeliveryDate": {
"type": "string",
"format": "date"
},
"latestDeliveryDate": {
"type": "string",
"format": "date"
},
"comment": {
"type": "string"
},
"transportInsuranceAmount": {
"type": "number"
},
"cashOnDeliveryAmount": {
"type": "number"
},
"cashOnDeliveryCurrency": {
"type": "string"
},
"deliveryInstruction": {
"type": "string"
},
"shippingMethodIdentifier": {
"type": "string"
},
"shippingMethodName": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
},
"earliestShipDate": {
"type": "string",
"format": "date"
},
"latestShipDate": {
"type": "string",
"format": "date"
},
"piiDataRemoved": {
"type": "boolean"
},
"paymentType": {
"type": "string"
},
"trackingEnabled": {
"type": "boolean"
},
"orderPriority": {
"type": "integer",
"format": "int32"
},
"fulfillmentConfirmed": {
"type": "boolean"
},
"entityErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityErrorDetail"
}
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderAttachmentGet"
}
},
"orderReference2": {
"type": "string"
},
"channelId": {
"type": "string"
},
"channelName": {
"type": "string"
}
}
},
"OrderEntryCountry": {
"type": "object",
"properties": {
"countryIso2": {
"type": "string"
},
"countryIso3": {
"type": "string"
},
"countryName": {
"type": "string"
},
"exportDocumentsRequired": {
"type": "boolean"
},
"shipToZip": {
"type": "string",
"enum": [
"OPTIONAL",
"REQUIRED",
"HIDDEN"
]
},
"shipToState": {
"type": "string",
"enum": [
"OPTIONAL",
"REQUIRED",
"HIDDEN"
]
}
}
},
"OrderEntrySellerWarehouse": {
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"format": "int64"
},
"warehouseIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"OrderFilterGet": {
"type": "object",
"properties": {
"orderedAfter": {
"type": "string",
"format": "date-time"
},
"referencePattern": {
"$ref": "#/components/schemas/Pattern"
},
"excludeDeliveryAddressCountries": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
}
},
"includeDeliveryAddressCountries": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"AF",
"AX",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"CI",
"HR",
"CU",
"CY",
"CZ",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IR",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KP",
"KR",
"XK",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MK",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RE",
"RO",
"RU",
"RW",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"LK",
"SD",
"SR",
"SJ",
"CW",
"BQ",
"SX",
"SZ",
"SE",
"CH",
"SY",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW"
]
}
}
}
},
"OrderPost": {
"required": [
"deliveryAddress",
"orderIdentifier",
"orderReference",
"positions",
"sellerId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "The seller id to which this order belongs.",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"description": "The id of the warehouse where the order gets processed. A list of warehouse identifiers and names can be obtained by executing GET /warehouses",
"format": "int64"
},
"orderIdentifier": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "A unique identifier to prevent duplicates of the same order in the system. It can be the id of the order in the shop system or another unique number"
},
"orderReference": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "The orderReference is set from the customer to identify the order easily. \n Example: #DE38678"
},
"hasInvoiceAddress": {
"type": "boolean",
"description": "Optional value indicating whether the invoice address is provided.
By default the delivery address is used as invoice address."
},
"hasInvoiceData": {
"type": "boolean",
"description": "Optional value indicating whether the invoice data is provided.
The invoice data includes currency and sales prices."
},
"deliveryAddress": {
"$ref": "#/components/schemas/OrderPostDeliveryAddress"
},
"invoiceAddress": {
"$ref": "#/components/schemas/OrderPostAddress"
},
"orderDate": {
"type": "string",
"description": "The date when the order was placed.",
"format": "date-time"
},
"currencyCode": {
"type": "string",
"description": "The currency in which the order was placed."
},
"invoiceIds": {
"type": "array",
"items": {
"type": "string"
}
},
"comment": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Optional text which contains instructions for the fulfillment and is sent to the warehouse."
},
"positions": {
"maxItems": 2147483647,
"minItems": 1,
"type": "array",
"description": "The content of the order.",
"items": {
"$ref": "#/components/schemas/OrderPostPosition"
}
},
"earliestDeliveryDate": {
"type": "string",
"description": "Optional date which indicates the earliest allowed date of delivery in ISO 8601 format. \n Example: 2021-01-10",
"format": "date"
},
"latestDeliveryDate": {
"type": "string",
"description": "Optional date which indicates the latest allowed date of delivery in ISO 8601 format. \n Example: 2021-01-12",
"format": "date"
},
"transportInsuranceAmount": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Optional amount which should get insured when booking the transport for this order in EUR."
},
"cashOnDeliveryAmount": {
"type": "number",
"description": "Optional COD total amount parameter. If the amount is greater than 0, it will be processed as a COD shipment"
},
"cashOnDeliveryCurrency": {
"type": "string",
"description": "Optional COD currency."
},
"shippingMethodIdentifier": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional identifier which indicates how the parcels should be transported. \n Example: UPSS"
},
"shippingMethodName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Optional name which indicates how the parcels should be transported. \n Example: UPS Saver"
},
"tags": {
"type": "array",
"description": "Optional tags of this order",
"items": {
"type": "string"
}
},
"trackingEnabled": {
"type": "boolean",
"description": "Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true."
},
"orderPriority": {
"maximum": 3,
"minimum": 1,
"type": "integer",
"description": "Optional value to prioritize order.",
"format": "int32"
},
"orderReference2": {
"maxLength": 40,
"minLength": 0,
"type": "string",
"description": "Optional value for additional orderReference\n Example: #DE38678"
},
"customerPurchaseOrderNumber": {
"maxLength": 255,
"minLength": 0,
"type": "string",
"description": "Optional value which specifies reference code that is assigned to a purchase\n Example: PO-89225"
},
"ssccLabel": {
"type": "boolean",
"description": "Optional value setting whether to create ssccLabel or not based on customerPurchaseOrderNumber value."
},
"channelId": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "Optional value which specifies the channel ID of the master client of this order."
},
"channelName": {
"maxLength": 100,
"minLength": 0,
"type": "string",
"description": "Optional value which specifies the channel name of the master client of this order.\n Example: Obi E-Commerce"
},
"attachments": {
"type": "array",
"description": "Optional attachments parameter",
"items": {
"$ref": "#/components/schemas/OrderAttachmentPost"
}
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of order.",
"example": "{\"attr1\":\"val1\"}"
}
}
},
"OrderPostAddress": {
"required": [
"city",
"countryIso2",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The first and lastname of the recipient.
Either name or company is required."
},
"company": {
"type": "string",
"description": "Name of the company.
Either name or company is required."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"email": {
"type": "string",
"description": "E-Mail address."
},
"street": {
"type": "string",
"description": "Street (or Address Line 1).
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
},
"zip": {
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country Code."
}
}
},
"OrderPostDeliveryAddress": {
"required": [
"city",
"countryIso2",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The first and lastname of the recipient.
Either name or company is required."
},
"company": {
"type": "string",
"description": "Name of the company.
Either name or company is required."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"email": {
"type": "string",
"description": "E-Mail address."
},
"street": {
"type": "string",
"description": "Street (or Address Line 1).
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
},
"zip": {
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country Code."
},
"addressIdentifier": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "Optional identifier for a delivery address."
},
"additionalIdentifiers": {
"type": "array",
"description": "Optional additional identifiers for a delivery address.",
"items": {
"$ref": "#/components/schemas/OrderAddressAdditionalIdentifier"
}
},
"latitude": {
"type": "number",
"description": "Latitude coordinate for the delivery address. Optional, used for location-based services.",
"format": "double"
},
"longitude": {
"type": "number",
"description": "Longitude coordinate for the delivery address. Optional, Used for location-based services.",
"format": "double"
}
}
},
"OrderPostPosition": {
"required": [
"name",
"quantity",
"sku"
],
"type": "object",
"properties": {
"sku": {
"type": "string",
"description": "The unique identifier of the article that was ordered."
},
"name": {
"type": "string",
"description": "A descriptive name of the article that was ordered."
},
"quantity": {
"type": "integer",
"description": "The quantity that was ordered.",
"format": "int32"
},
"price": {
"type": "number",
"description": "The price per piece including taxes.
Required if hasInvoiceData is set to true."
},
"lot": {
"type": "string",
"description": "Optional value that means a batch, or a specific identified portion of a batch, having uniform character and quality within specified limits."
},
"expirationDate": {
"type": "string",
"description": "Optional expiration date.",
"format": "date"
},
"location": {
"type": "string",
"description": "Optional storage location."
},
"positionIdentifier": {
"maxLength": 25,
"minLength": 0,
"type": "string",
"description": "Optional position identifier which is set from the customer to this position"
},
"productIdentifier": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Optional product identifier which is set from the customer to this position"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional custom attributes for a position.",
"example": "{\"attr1\":\"val1\"}"
}
}
},
"OrderPostResult": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Indicates the overall status of the order creation attempt. Typically \"OK\" on success, or an error status on failure."
},
"field": {
"type": "string",
"description": "On failure, this field indicates the specific request field that caused the error (e.g., \"deliveryAddress.countryIso2\"). This field is null on success."
},
"message": {
"type": "string",
"description": "A detailed, human-readable message describing the outcome of the operation. This may contain success confirmation or a specific error explanation."
},
"orderId": {
"type": "integer",
"format": "int64",
"description": "The unique internal ID assigned to the new order upon successful creation. This field is null on failure."
}
},
"description": "Represents the outcome of an order creation request, indicating whether the operation was successful (status) and, if successful, providing the new orderId. It includes fields for error messages if the operation failed."
},
"OrderPut": {
"type": "object",
"properties": {
"address": {
"$ref": "#/components/schemas/OrderPutDeliveryAddress"
},
"comment": {
"maxLength": 250,
"minLength": 0,
"type": "string",
"description": "Optional text which contains instructions for the fulfillment and is sent to the warehouse."
},
"trackingEnabled": {
"type": "boolean",
"description": "Optional value setting whether to turn on/off tracking functionality for an order. Additional charges will apply when set to true."
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of order.",
"example": "{\"attr1\":\"val1\"}"
}
}
},
"OrderPutDeliveryAddress": {
"required": [
"city",
"countryIso2",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The first and lastname of the recipient.
Either name or company is required."
},
"company": {
"type": "string",
"description": "Name of the company.
Either name or company is required."
},
"phone": {
"type": "string",
"description": "Phone number."
},
"email": {
"type": "string",
"description": "E-Mail address."
},
"street": {
"type": "string",
"description": "Street (or Address Line 1).
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
},
"zip": {
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country Code."
},
"latitude": {
"type": "number",
"description": "Latitude coordinate for the delivery address. Optional, used for location-based services. For invoice address, it'll be ignored if provided.",
"format": "double"
},
"longitude": {
"type": "number",
"description": "Longitude coordinate for the delivery address. Optional, Used for location-based services. For invoice address, it'll be ignored if provided.",
"format": "double"
}
}
},
"OrderSummary": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64",
"description": "The unique internal identifier for the order."
},
"sellerId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier for the seller account associated with the order."
},
"created": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the order record was initially created."
},
"lastModified": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the order record was last modified."
},
"orderIdentifier": {
"type": "string",
"description": "A unique identifier from the source system (e.g., shop system) to prevent duplicate order creation."
},
"orderReference": {
"type": "string",
"description": "An easy-to-read reference number for the order, typically set by the customer or shop."
},
"orderStatus": {
"type": "string",
"description": "The current fulfillment status of the order (e.g., 'PENDING', 'PROCESSING', 'COMPLETED')."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Optional list of descriptive tags applied to the order."
},
"orderDate": {
"type": "string",
"format": "date-time",
"description": "The date and time when the order was placed by the customer."
},
"cancelRequestedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp if a cancellation request was logged for the order."
},
"shipToCountry": {
"type": "string",
"description": "The ISO 2 country code (e.g., 'DE', 'US') for the delivery address."
},
"shipToZip": {
"type": "string",
"description": "The ZIP code for the delivery address."
},
"shipToCompany": {
"type": "string",
"description": "The company name for the delivery address."
},
"shipToName1": {
"type": "string",
"description": "The first name/line 1 name for the delivery address."
},
"shipToName2": {
"type": "string",
"description": "The second name/line 2 name for the delivery address."
},
"shipToAddressIdentifier": {
"type": "string",
"description": "An optional identifier for the delivery address (e.g., a store ID)."
},
"shipToAdditionalIdentifiers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrderAddressAdditionalIdentifier"
},
"description": "Additional unique identifiers for the shipping address (e.g., GLN)."
},
"earliestPredatedShipment": {
"type": "string",
"format": "date",
"description": "The earliest allowed date for the order to be shipped."
},
"latestPredatedShipment": {
"type": "string",
"format": "date",
"description": "The latest allowed date for the order to be shipped."
},
"shipmentTracking": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TrackingSummary"
},
"description": "A list of tracking numbers and links associated with shipments for this order."
},
"completedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the order was marked as fulfilled/completed."
},
"exportedAt": {
"type": "string",
"format": "date-time",
"description": "Timestamp when the order was exported to the warehouse management system."
},
"shipToEmail": {
"type": "string",
"description": "The email address for the delivery recipient."
},
"billToEmail": {
"type": "string",
"description": "The email address for the invoice recipient."
},
"piiDataRemoved": {
"type": "boolean",
"description": "Indicates if Personally Identifiable Information (PII) has been removed from the order record."
},
"totalShipmentWeight": {
"type": "number",
"description": "The total weight of all shipments associated with the order (in kg)."
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PositionSummary"
},
"description": "A summary list of the products originally ordered by the customer."
},
"fulfillmentOrders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FulfillmentOrderSummary"
},
"description": "Details of how the order was split and planned for physical fulfillment in the warehouse(s)."
},
"entityErrors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EntityErrorSummary"
},
"description": "A list of critical errors preventing the fulfillment process."
},
"sort": {
"$ref": "#/components/schemas/JsonNode",
"description": "Internal object used for controlling search result ordering."
},
"shopId": {
"type": "integer",
"format": "int64",
"description": "The unique identifier of the source shop system."
},
"shopSystem": {
"type": "string",
"description": "The technical name of the shop system (e.g., 'Shopware', 'Shopify')."
},
"shopSystemName": {
"type": "string",
"description": "The display name of the shop system."
},
"customerPurchaseOrderNumber": {
"type": "string",
"description": "A reference code assigned to the purchase order by the customer."
},
"channelId": {
"type": "string",
"description": "The ID of the sales channel associated with the order."
},
"channelName": {
"type": "string",
"description": "The name of the sales channel associated with the order."
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Arbitrary key-value pairs for storing custom data related to the order."
}
},
"description": "Provides a high-level summary of an order, including primary identifiers (orderId, orderIdentifier), current status, timestamps, key shipping details (like destination country and ZIP), and a list of included positions and fulfillment details."
},
"PackagingUnitDetail": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"PALLET",
"CARTON"
]
},
"barcode": {
"type": "string"
},
"piecesPerPackagingUnit": {
"type": "integer",
"format": "int32"
},
"grossWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"netWeight": {
"$ref": "#/components/schemas/WeightDetail"
},
"length": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"width": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"height": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
}
}
},
"Pattern": {
"type": "object"
},
"PickupsPostRequest": {
"required": [
"parcelCount",
"pickupDate",
"sellerId",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Required seller for which to book the pickup.",
"format": "int64"
},
"shippingServiceGroupId": {
"type": "integer",
"description": "Required shipping service group for which to book the pickup.",
"format": "int64"
},
"parcelCount": {
"minimum": 1,
"type": "integer",
"description": "Required count of parcels which need to be picked up.",
"format": "int32"
},
"pickupDate": {
"type": "string",
"description": "Required day when the booked shipments should be picked up.",
"format": "date"
},
"pickupFrom": {
"$ref": "#/components/schemas/ShipmentAddress"
}
}
},
"PingResponse": {
"type": "object",
"properties": {
"status": {
"type": "string"
}
}
},
"PlanThenGet": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"quantity": {
"type": "string"
},
"warehouse": {
"type": "string"
},
"customsValue": {
"type": "string"
},
"splitId": {
"type": "string"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"PlanThenPost": {
"type": "object",
"properties": {
"order": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"quantity": {
"type": "string"
},
"warehouse": {
"type": "string"
},
"customsValue": {
"type": "string"
},
"splitId": {
"type": "string"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string"
}
}
},
"PlanWhenGet": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RULE",
"PRE",
"POST"
]
},
"order": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"deliveryCountry": {
"type": "string"
},
"scriptedCondition": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
},
"thens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanThenGet"
}
}
}
},
"PlanWhenPost": {
"type": "object",
"properties": {
"type": {
"type": "string",
"enum": [
"RULE",
"PRE",
"POST"
]
},
"order": {
"type": "integer",
"format": "int32"
},
"sku": {
"type": "string"
},
"deliveryCountry": {
"type": "string"
},
"scriptedCondition": {
"type": "string"
},
"thens": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PlanThenPost"
}
}
}
},
"PlatformGet": {
"type": "object"
},
"PodDocumentGet": {
"type": "object",
"properties": {
"fileName": {
"type": "string"
},
"fileKey": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
},
"mimeType": {
"type": "string"
}
}
},
"PositionDetail": {
"type": "object",
"properties": {
"positionId": {
"type": "integer",
"format": "int64"
},
"positionIdentifier": {
"type": "string"
},
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"productIdentifier": {
"type": "string"
},
"variantIdentifier": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"location": {
"type": "string"
},
"bundledBy": {
"type": "string"
},
"unitWeight": {
"type": "number"
},
"unitNetPrice": {
"type": "number"
},
"unitGrossPrice": {
"type": "number"
},
"totalWeight": {
"type": "number"
},
"totalNetAmount": {
"type": "number"
},
"totalGrossAmount": {
"type": "number"
},
"expirationDate": {
"type": "string",
"format": "date-time"
}
}
},
"PositionSummary": {
"type": "object",
"properties": {
"positionId": {
"type": "integer",
"format": "int64",
"description": "The unique internal identifier for the order position."
},
"positionIdentifier": {
"type": "string",
"description": "A unique identifier for the position from the source system."
},
"name": {
"type": "string",
"description": "The descriptive name of the ordered product."
},
"sku": {
"type": "string",
"description": "The Stock Keeping Unit (SKU) of the ordered product."
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Arbitrary key-value pairs for storing custom data related to the position."
}
},
"description": "A summarized view of an individual ordered line item, containing identifiers, the product SKU, its name, and any associated custom attributes."
},
"PreviewFulfillmentOrder": {
"type": "object",
"properties": {
"warehouse": {
"type": "string"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PreviewFulfillmentOrderPosition"
}
}
}
},
"PreviewFulfillmentOrderPosition": {
"type": "object",
"properties": {
"sku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"customsValue": {
"type": "number"
},
"expirationDate": {
"type": "string",
"format": "date-time"
}
}
},
"PreviewRequest": {
"type": "object",
"properties": {
"orderId": {
"type": "integer",
"format": "int64"
},
"excludeWhenIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"when": {
"$ref": "#/components/schemas/PlanWhenPost"
}
}
},
"RatingPost": {
"type": "object",
"properties": {
"rating": {
"type": "number",
"format": "float"
},
"ratingMessage": {
"type": "string"
}
}
},
"Response": {
"type": "object",
"properties": {
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Data"
}
},
"errors": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Error"
}
}
}
},
"ReturnAppCountry": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"countryIso2": {
"type": "string"
},
"countryIso3": {
"type": "string"
},
"shipToZip": {
"type": "string",
"enum": [
"OPTIONAL",
"REQUIRED",
"HIDDEN"
]
},
"shipToState": {
"type": "string",
"enum": [
"OPTIONAL",
"REQUIRED",
"HIDDEN"
]
}
}
},
"ReturnLinkGet": {
"required": [
"sellerId",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"shippingServiceGroupId": {
"type": "integer",
"description": "Shipping Service Group ID.
Required shipping service group for which to create a return link.",
"format": "int64"
},
"shipToAddress": {
"$ref": "#/components/schemas/AddressDetail"
},
"defaultWeightKG": {
"type": "number",
"description": "Default weight in KG."
},
"weightInputVisible": {
"type": "boolean",
"description": "Indicates if weight input should be visible."
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"returnLink": {
"type": "string"
},
"shippingServiceGroupName": {
"type": "string"
}
}
},
"ReturnLinkPost": {
"required": [
"sellerId",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"shippingServiceGroupId": {
"type": "integer",
"description": "Shipping Service Group ID.
Required shipping service group for which to create a return link.",
"format": "int64"
},
"shipToAddress": {
"$ref": "#/components/schemas/AddressDetail"
},
"defaultWeightKG": {
"type": "number",
"description": "Default weight in KG."
},
"weightInputVisible": {
"type": "boolean",
"description": "Indicates if weight input should be visible."
}
}
},
"ReturnLinkSummary": {
"required": [
"sellerId",
"shippingServiceGroupId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"shippingServiceGroupId": {
"type": "integer",
"description": "Shipping Service Group ID.
Required shipping service group for which to create a return link.",
"format": "int64"
},
"shipToAddress": {
"$ref": "#/components/schemas/AddressDetail"
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"returnLink": {
"type": "string"
},
"shippingServiceGroupName": {
"type": "string"
}
}
},
"ReturnShipmentCommentDetail": {
"type": "object",
"properties": {
"returnShipmentCommentId": {
"type": "integer",
"format": "int64"
},
"text": {
"type": "string"
},
"fileKey": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
},
"returnShipmentImages": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnShipmentImageDetail"
}
}
}
},
"ReturnShipmentDetail": {
"type": "object",
"properties": {
"returnShipmentId": {
"type": "integer",
"format": "int64"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"returnShipmentIdentifier": {
"type": "string"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"receivedDate": {
"type": "string",
"format": "date-time"
},
"trackingNumber": {
"type": "string"
},
"trackingLink": {
"type": "string"
},
"carrierSlug": {
"type": "string"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"fulfillmentOrderId": {
"type": "integer",
"format": "int64"
},
"returnAnnouncementId": {
"type": "integer",
"format": "int64"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressDetail"
},
"returnShipmentReference": {
"type": "string"
},
"customerExamined": {
"type": "boolean"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnShipmentPositionDetail"
}
},
"groupedPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedReturnShipmentPositionDetail"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnShipmentCommentDetail"
}
}
}
},
"ReturnShipmentImageDetail": {
"type": "object",
"properties": {
"text": {
"type": "string"
},
"fileKey": {
"type": "string"
},
"url": {
"$ref": "#/components/schemas/Link"
}
}
},
"ReturnShipmentPositionDetail": {
"type": "object",
"properties": {
"returnShipmentPositionId": {
"type": "integer",
"format": "int64"
},
"sellerSku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"name": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
}
},
"classCode": {
"type": "string"
},
"classDescription": {
"type": "string"
},
"reasonCode": {
"type": "string"
},
"reasonDescription": {
"type": "string"
},
"positionIdentifier": {
"type": "string"
},
"storageCode": {
"type": "string"
},
"storageBlocked": {
"type": "boolean"
}
}
},
"ReturnShipmentPositionSummary": {
"type": "object",
"properties": {
"sellerSku": {
"type": "string"
},
"warehouseSku": {
"type": "string"
},
"name": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"classCode": {
"type": "string"
},
"lot": {
"type": "string"
},
"expirationDate": {
"type": "string",
"format": "date-time"
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
}
},
"reasonCode": {
"type": "string"
},
"reasonDescription": {
"type": "string"
},
"classDescription": {
"type": "string"
},
"positionIdentifier": {
"type": "string"
}
}
},
"ReturnShipmentSummary": {
"type": "object",
"properties": {
"warehouseId": {
"type": "integer",
"format": "int64"
},
"returnShipmentIdentifier": {
"type": "string"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"returnShipmentId": {
"type": "integer",
"format": "int64"
},
"orderId": {
"type": "integer",
"format": "int64"
},
"fulfillmentOrderId": {
"type": "integer",
"format": "int64"
},
"returnAnnouncementId": {
"type": "integer",
"format": "int64"
},
"receivedDate": {
"type": "string",
"format": "date-time"
},
"shipFromCountry": {
"type": "string"
},
"shipFromZip": {
"type": "string"
},
"shipFromCompany": {
"type": "string"
},
"shipFromName1": {
"type": "string"
},
"shipFromName2": {
"type": "string"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"trackingLink": {
"type": "string"
},
"trackingNumber": {
"type": "string"
},
"carrierSlug": {
"type": "string"
},
"returnShipmentReference": {
"type": "string"
},
"customerExamined": {
"type": "boolean"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnShipmentPositionSummary"
}
},
"groupedPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedReturnShipmentPositionSummary"
}
}
}
},
"SellerAddress": {
"required": [
"city",
"countryIso2",
"email",
"name",
"phone"
],
"type": "object",
"properties": {
"name": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Contact name.
Usually this is the first and last name."
},
"phone": {
"maxLength": 30,
"minLength": 0,
"type": "string",
"description": "Phone number."
},
"email": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "E-Mail address."
},
"zip": {
"maxLength": 29,
"minLength": 0,
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"maxLength": 30,
"minLength": 0,
"type": "string",
"description": "City.
The city should always be specified."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country.
The country should always be specified."
},
"street": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Street (or Address Line 1).
This field is optional."
},
"street2": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
}
}
},
"SellerGet": {
"required": [
"sellerAddress",
"sendToEmail",
"subscriptionPackage"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"usesWarehouseSku": {
"type": "boolean"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"companyName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Company name.
Necessary for VAT Registration Number"
},
"sendToEmail": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "E-Mail address to send invoices."
},
"sellerServices": {
"type": "array",
"items": {
"type": "string"
}
},
"pixiSellerIdentifier": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "SellerIdentifier used in Pixi
Necessary for Pixi sellers"
},
"pixiArticlePrefix": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "ArticlePrefix used for Pixi articles
Necessary for Pixi sellers"
},
"pixiManualOrderPrefix": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "OrderPrefix used for Pixi orders created manually
Necessary for Pixi sellers"
},
"allowInboundOverReceiving": {
"type": "boolean",
"description": "Optional value indicating if seller can over receive more than announced during inbounds.
Default value is true."
},
"allowReturnOverReceiving": {
"type": "boolean",
"description": "Optional value indicating if seller can receive more than announced during returns.
Default value is true."
},
"lottableIdRequired": {
"type": "boolean",
"description": "Optional value indicating if seller requires to replace lot no. with lottable ID.
Default value is false."
},
"sendToCcEmail": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "CC E-Mail address to send invoices.
This field is optional."
},
"voecNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "VOEC Number Norway."
},
"vatNumber": {
"maxLength": 20,
"minLength": 0,
"type": "string",
"description": "VAT Registration Number."
},
"vatNumberRequired": {
"type": "boolean",
"description": "Optional value indicating whether the VAT number is required or not."
},
"homePage": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "Home page url.
This field is optional."
},
"useArticleBaseData": {
"type": "boolean",
"description": "Optional value indicating whether the article data is used as base data when some fields are missing in shop system.
By default article data is not used as base data."
},
"eoriNumber": {
"maxLength": 35,
"minLength": 0,
"type": "string",
"description": "EORI number.
This field is optional."
},
"sellerAddress": {
"$ref": "#/components/schemas/SellerAddress"
},
"vatNumberPerCountry": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Vat numbers per country.
This field is optional."
},
"eoriNumberPerCountry": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Eori numbers per country.
This field is optional."
},
"subscriptionPackage": {
"type": "string",
"description": "Subscription package for this Seller",
"enum": [
"RISING_STAR",
"STELLAR_EXPLORER",
"FULFILLED_LEGEND",
"WITHOUT_PACKAGE",
"SEND_IT_YOURSELF",
"CUSTOMIZED"
]
},
"sellerLogo": {
"$ref": "#/components/schemas/Link"
},
"exportedAt": {
"type": "string",
"format": "date-time"
},
"connectorApiKey": {
"type": "string"
},
"managingGroup": {
"type": "string",
"enum": [
"QUIVO",
"GWC"
]
},
"trackingEnabled": {
"type": "boolean"
},
"dimensionsRequired": {
"type": "boolean"
},
"customAttributes": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "Optional value for custom attributes of article.",
"example": "{\"attr1\":\"val1\"}"
}
}
},
"SellerGetSummary": {
"required": [
"sendToEmail"
],
"type": "object",
"properties": {
"name": {
"type": "string"
},
"usesWarehouseSku": {
"type": "boolean"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"companyName": {
"maxLength": 50,
"minLength": 0,
"type": "string",
"description": "Company name.
Necessary for VAT Registration Number"
},
"sendToEmail": {
"maxLength": 80,
"minLength": 0,
"type": "string",
"description": "E-Mail address to send invoices."
},
"sellerServices": {
"type": "array",
"items": {
"type": "string"
}
},
"pixiSellerIdentifier": {
"maxLength": 5,
"minLength": 0,
"type": "string",
"description": "SellerIdentifier used in Pixi
Necessary for Pixi sellers"
},
"pixiArticlePrefix": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "ArticlePrefix used for Pixi articles
Necessary for Pixi sellers"
},
"pixiManualOrderPrefix": {
"maxLength": 10,
"minLength": 0,
"type": "string",
"description": "OrderPrefix used for Pixi orders created manually
Necessary for Pixi sellers"
},
"allowInboundOverReceiving": {
"type": "boolean",
"description": "Optional value indicating if seller can over receive more than announced during inbounds.
Default value is true."
},
"allowReturnOverReceiving": {
"type": "boolean",
"description": "Optional value indicating if seller can receive more than announced during returns.
Default value is true."
},
"lottableIdRequired": {
"type": "boolean",
"description": "Optional value indicating if seller requires to replace lot no. with lottable ID.
Default value is false."
},
"id": {
"type": "integer",
"format": "int64"
},
"identifier": {
"type": "string"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"status": {
"type": "string",
"enum": [
"ACTIVE",
"BLOCKED",
"TERMINATED",
"NEW",
"PENDING"
]
}
}
},
"SellerLogoPost": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"description": "Identifier of the image file to be saved."
},
"mimeType": {
"type": "string",
"description": "Mime type of the image file"
}
}
},
"SellerSubscriptionPackageInfoGet": {
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"format": "int64"
},
"subscriptionPackage": {
"type": "string",
"enum": [
"RISING_STAR",
"STELLAR_EXPLORER",
"FULFILLED_LEGEND",
"WITHOUT_PACKAGE",
"SEND_IT_YOURSELF",
"CUSTOMIZED"
]
},
"articles": {
"$ref": "#/components/schemas/SellerSubscriptionPackageLimitationGet"
},
"shops": {
"$ref": "#/components/schemas/SellerSubscriptionPackageLimitationGet"
}
}
},
"SellerSubscriptionPackageLimitationGet": {
"type": "object",
"properties": {
"active": {
"type": "integer",
"format": "int32"
},
"allowed": {
"type": "integer",
"format": "int32"
}
}
},
"ServiceStatusGet": {
"required": [
"end",
"service",
"start"
],
"type": "object",
"properties": {
"service": {
"type": "string",
"enum": [
"SHIPMENTS"
]
},
"start": {
"type": "string",
"format": "date-time"
},
"end": {
"type": "string",
"format": "date-time"
},
"message": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"ShipmentAddress": {
"required": [
"city",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the recipient.
Usually this is the first and lastname of the recipient."
},
"company": {
"type": "string",
"description": "Name of the company."
},
"phone": {
"type": "string",
"description": "Phone number of the recipient.
The phone number is usually optional."
},
"email": {
"type": "string",
"description": "E-Mail address of the recipient."
},
"zip": {
"type": "string",
"description": "ZIP Code of the recipient
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City of the recipient.
The city should always be specified."
},
"state": {
"type": "string",
"description": "State of the recipient.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string"
},
"street": {
"type": "string",
"description": "Street (or Address Line 1) of the recipient.
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2) of the recipient.
This field is optional."
}
}
},
"ShipmentAttachmentPost": {
"type": "object",
"properties": {
"fileName": {
"type": "string",
"description": "Name for the attachment"
},
"fileKey": {
"type": "string",
"description": "Identifier of the file to be attached."
},
"mimeType": {
"type": "string",
"description": "Mime type of the file"
}
}
},
"ShipmentAttachmentUpload": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"description": "File key which should be used for uploading the file and adding the attachment"
},
"uploadUrl": {
"type": "string",
"description": "URL for uploading the attachment"
},
"mimeType": {
"type": "string",
"description": "Mimetype of the attachment"
}
}
},
"ShipmentDeliveryAddress": {
"required": [
"city",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the recipient.
Usually this is the first and lastname of the recipient."
},
"company": {
"type": "string",
"description": "Name of the company."
},
"phone": {
"type": "string",
"description": "Phone number of the recipient.
The phone number is usually optional."
},
"email": {
"type": "string",
"description": "E-Mail address of the recipient."
},
"zip": {
"type": "string",
"description": "ZIP Code of the recipient
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City of the recipient.
The city should always be specified."
},
"state": {
"type": "string",
"description": "State of the recipient.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string"
},
"street": {
"type": "string",
"description": "Street (or Address Line 1) of the recipient.
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2) of the recipient.
This field is optional."
},
"latitude": {
"type": "number",
"description": "Latitude of the address.
This field is optional and used for some carriers to optimize the delivery process.",
"format": "double"
},
"longitude": {
"type": "number",
"description": "Longitude of the address.
This field is optional and used for some carriers to optimize the delivery process.",
"format": "double"
}
}
},
"ShipmentDetail": {
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int64"
},
"shipmentIdentifier": {
"type": "string"
},
"provider": {
"type": "string"
},
"trackingLink": {
"type": "string"
},
"trackingLinks": {
"type": "array",
"items": {
"type": "string"
}
},
"trackingNumber": {
"type": "string"
},
"trackingNumbers": {
"type": "array",
"items": {
"type": "string"
}
},
"shipDate": {
"type": "string",
"format": "date-time"
},
"isUntracked": {
"type": "boolean"
},
"sscc": {
"type": "string"
},
"predatedShipment": {
"type": "string",
"format": "date"
},
"carrierPickUpDate": {
"type": "string",
"format": "date-time"
},
"deliveryWindowStartTime": {
"type": "string",
"format": "date-time"
},
"deliveryWindowEndTime": {
"type": "string",
"format": "date-time"
},
"providerName": {
"type": "string"
},
"numberOfPallets": {
"type": "integer",
"format": "int32"
},
"numberOfParcels": {
"type": "integer",
"format": "int32"
},
"grossWeight": {
"type": "number"
},
"width": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"length": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"height": {
"$ref": "#/components/schemas/LengthMeasurementDetail"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentPositionDetail"
}
},
"reversed": {
"type": "boolean"
},
"bookedShipmentId": {
"type": "integer",
"format": "int64"
},
"expectedDeliveryDate": {
"type": "string",
"format": "date-time"
},
"deliveryDate": {
"type": "string",
"format": "date-time"
},
"podDate": {
"type": "string",
"format": "date-time"
},
"groupedPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GroupedShipmentPositionDetail"
}
},
"podDocuments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PodDocumentGet"
}
}
}
},
"ShipmentDocumentGet": {
"type": "object",
"properties": {
"shipmentDocumentId": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string",
"enum": [
"LABEL",
"EXPORT_DOCUMENT",
"NON_PRINT_EXPORT_DOCUMENT",
"MANIFEST_DOCUMENT",
"RETURN_LABEL"
]
}
}
},
"ShipmentDocumentSummary": {
"type": "object",
"properties": {
"shipmentDocumentId": {
"type": "integer",
"format": "int64"
},
"type": {
"type": "string"
}
}
},
"ShipmentParcelGet": {
"required": [
"weight"
],
"type": "object",
"properties": {
"weight": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Parcel weight (kilograms) including packaging."
},
"length": {
"type": "number",
"description": "Parcel package length (meters)
This field will be considered only if width and height are filled as well."
},
"width": {
"type": "number",
"description": "Parcel package width (meters)
This field will be considered only if length and height are filled as well."
},
"height": {
"type": "number",
"description": "Parcel package height (meter)
This field will be considered only if length and width are filled as well."
},
"reference": {
"type": "string",
"description": "Parcel package reference for the current shipment (meter)"
}
}
},
"ShipmentPositionDetail": {
"type": "object",
"properties": {
"shipmentPositionId": {
"type": "integer",
"format": "int64",
"description": "The unique internal identifier for the shipment position."
},
"sku": {
"type": "string",
"description": "The SKU used for the shipment position."
},
"warehouseSku": {
"type": "string",
"description": "The SKU as known in the warehouse system."
},
"sellerSku": {
"type": "string",
"description": "The original SKU from the seller."
},
"quantity": {
"type": "integer",
"format": "int32",
"description": "The quantity shipped in this position."
},
"lot": {
"type": "string",
"description": "The lot number of the item shipped."
},
"location": {
"type": "string",
"description": "The storage location where the item was picked from."
},
"expirationDate": {
"type": "string",
"format": "date-time",
"description": "The expiration date of the product shipped."
},
"serialNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "A list of serial numbers for tracked items."
},
"positionIdentifier": {
"type": "string",
"description": "The unique identifier for the shipment position."
}
},
"description": "Detailed information about a specific item included within a shipment, including its allocated quantity, lot, location, and serial numbers."
},
"ShipmentSummary": {
"type": "object",
"properties": {
"shipmentId": {
"type": "integer",
"format": "int64",
"description": "The unique internal identifier for the shipment."
},
"shipmentIdentifier": {
"type": "string",
"description": "The unique reference for the shipment, typically assigned by the system."
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentPositionDetail"
},
"description": "The list of items and quantities contained within this specific shipment."
}
},
"description": "A summary of a particular shipment created for the order, including its unique identifiers and the list of specific items/quantities enclosed."
},
"ShippingOrderGet": {
"type": "object",
"properties": {
"shipTo": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"shipFrom": {
"$ref": "#/components/schemas/ShipmentDeliveryAddress"
},
"reference": {
"type": "string"
},
"grossWeightKg": {
"type": "number",
"description": "The gross weight of the shipment's main parcel in kg, which does not include the weight of any additional parcels."
},
"lengthM": {
"type": "number",
"description": "The length of the shipment's main parcel in meters."
},
"widthM": {
"type": "number",
"description": "The width of the shipment's main parcel in meters."
},
"heightM": {
"type": "number",
"description": "The height of the shipment's main parcel in meters."
},
"totalWeight": {
"type": "number",
"description": "The total weight of the shipment in kg, which is the sum of the weight of the main as well as all additional parcels in this shipment."
},
"totalVolume": {
"type": "number",
"description": "The total volume of the shipment in m3, which is the sum of the volume of the main as well as all additional parcels in this shipment."
},
"shipmentDate": {
"type": "string",
"format": "date-time"
},
"invoiceNumber": {
"type": "string"
},
"invoiceDate": {
"type": "string",
"format": "date-time"
},
"includeReturnLabel": {
"type": "boolean"
},
"trackingEnabled": {
"type": "boolean"
},
"userIdentifier": {
"type": "string"
},
"cashOnDeliveryAmount": {
"type": "number"
},
"cashOnDeliveryCurrency": {
"$ref": "#/components/schemas/Currency"
},
"customsPositions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ExportPositionGet"
}
},
"transportInsuranceAmount": {
"type": "number"
},
"termsOfTrade": {
"type": "string",
"enum": [
"DAP",
"DDP"
]
},
"additionalParcels": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShipmentParcelGet"
}
},
"orderReference": {
"type": "string",
"description": "Reference for the order from the customer shop system"
}
}
},
"ShippingServiceGroupCountryExtendedGet": {
"type": "object",
"properties": {
"iso2": {
"type": "string"
},
"iso3": {
"type": "string"
},
"name": {
"type": "string"
},
"shippingServiceGroupIds": {
"type": "string"
},
"shipToZip": {
"type": "string"
},
"shipToState": {
"type": "string"
},
"exportDocumentsRequired": {
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
}
},
"ShippingServiceGroupGet": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"pickupSupported": {
"type": "boolean"
},
"id": {
"type": "integer",
"format": "int64"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"carrierSlugs": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"shippingServices": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"shippingServiceIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
},
"shipmentContentTypes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"NON_DOCUMENT",
"DOCUMENT"
]
}
},
"additionalParcelsSupported": {
"type": "boolean"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"serviceModes": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string",
"enum": [
"RETURN",
"EXPORT",
"IMPORT",
"CROSS_TRADE"
]
}
}
}
},
"ShopAddressDetail": {
"type": "object",
"properties": {
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"company": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"zip": {
"type": "string"
},
"city": {
"type": "string"
},
"state": {
"type": "string"
},
"country": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
}
}
},
"ShopAuthorizeRequest": {
"required": [
"shopType"
],
"type": "object",
"properties": {
"shopType": {
"type": "string",
"enum": [
"AMAZON",
"WIX",
"OTTO_MARKETPLACE",
"SHOPIFY",
"TIKTOK"
]
},
"oauthCode": {
"type": "string"
},
"redirectUri": {
"type": "string"
},
"authUrl": {
"type": "string"
},
"state": {
"type": "string"
}
}
},
"ShopAuthorizeResult": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"refreshToken": {
"type": "string"
},
"message": {
"type": "string"
},
"shopId": {
"type": "integer",
"format": "int64"
}
}
},
"ShopGet": {
"required": [
"endpoint",
"platform",
"sellerId"
],
"type": "object",
"properties": {
"endpoint": {
"$ref": "#/components/schemas/EndpointGet"
},
"platform": {
"$ref": "#/components/schemas/PlatformGet"
},
"sellerId": {
"type": "integer",
"format": "int64"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"enabled": {
"type": "boolean"
},
"enabledExportFulfillment": {
"type": "boolean"
},
"enabledExportInventory": {
"type": "boolean"
},
"enabledInboundImport": {
"type": "boolean"
},
"enabledInboundExportFulfillment": {
"type": "boolean"
},
"fulfillmentQuantityMode": {
"type": "string",
"enum": [
"INFINITE",
"IN_STOCK",
"AVAILABLE",
"AVAILABLE_SOON"
]
},
"language": {
"type": "string"
},
"hideEmailFromCarrier": {
"type": "boolean"
},
"warehouseId": {
"type": "integer",
"format": "int64"
},
"orderFilter": {
"$ref": "#/components/schemas/OrderFilterGet"
},
"externallyFulfilledShippingMethodIds": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"readTariffNumber": {
"type": "boolean"
},
"readCountryOfOrigin": {
"type": "boolean"
},
"readCustomsValue": {
"type": "boolean"
},
"readWeight": {
"type": "boolean"
},
"hideEmailFromOrder": {
"type": "boolean"
},
"orderImportPageSize": {
"type": "integer",
"format": "int32"
},
"pixiOrderPrefix": {
"type": "string"
},
"defaultShippingMethod": {
"type": "string"
},
"exportInventoryIntervalMinutes": {
"type": "integer",
"format": "int32"
},
"exportInventoryCalculationMode": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int64"
}
}
},
"ShopOrderSummary": {
"type": "object",
"properties": {
"orderIdentifier": {
"type": "string"
},
"orderReference": {
"type": "string"
},
"orderStatus": {
"type": "string",
"enum": [
"PENDING",
"PROCESSING",
"COMPLETED",
"CANCELLED"
]
},
"orderStatusIdentifier": {
"type": "string"
},
"orderStatusName": {
"type": "string"
},
"orderDate": {
"type": "string",
"format": "date-time"
},
"currency": {
"$ref": "#/components/schemas/Currency"
},
"deliveryAddress": {
"$ref": "#/components/schemas/ShopAddressDetail"
},
"invoiceAddress": {
"$ref": "#/components/schemas/ShopAddressDetail"
},
"positions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShopPositionDetail"
}
}
}
},
"ShopOrdersGetResult": {
"type": "object",
"properties": {
"orders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ShopOrderSummary"
}
},
"nextPageToken": {
"type": "string",
"description": "Use this token to load the next page. A value of null indicates that there is no next page."
}
}
},
"ShopPositionDetail": {
"type": "object",
"properties": {
"positionIdentifier": {
"type": "string"
},
"productIdentifier": {
"type": "string"
},
"variantIdentifier": {
"type": "string"
},
"name": {
"type": "string"
},
"sku": {
"type": "string"
},
"quantity": {
"type": "integer",
"format": "int32"
},
"unitWeight": {
"type": "number"
},
"unitNetPrice": {
"type": "number"
},
"unitGrossPrice": {
"type": "number"
}
}
},
"StatusGetResponse": {
"type": "object",
"properties": {
"current": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ServiceStatusGet"
}
}
}
},
"StoredAddress": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"version": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"sort": {
"type": "string"
},
"typeId": {
"type": "string"
}
}
},
"StoredAddressGet": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"lastModified": {
"type": "string",
"format": "date-time"
},
"identifierType": {
"type": "string",
"enum": [
"GLN",
"AMAZON_FCID",
"SHOP_SPECIFIC",
"STORE_ID"
]
},
"identifier": {
"type": "string"
},
"company": {
"type": "string"
},
"city": {
"type": "string"
},
"country": {
"type": "string"
},
"name1": {
"type": "string"
},
"name2": {
"type": "string"
},
"address1": {
"type": "string"
},
"address2": {
"type": "string"
},
"address3": {
"type": "string"
},
"zip": {
"type": "string"
},
"state": {
"type": "string"
},
"phone": {
"type": "string"
},
"email": {
"type": "string"
},
"deletedAt": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"StringI18nDetail": {
"type": "object",
"properties": {
"value": {
"maxLength": 255,
"minLength": 0,
"type": "string"
},
"language": {
"type": "string",
"enum": [
"DE",
"EN",
"ES",
"PT",
"FR",
"IT",
"ZH"
]
}
}
},
"SubscriptionGet": {
"required": [
"endpoint",
"entity",
"sellerId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Required seller for which to make a subscription.",
"format": "int64"
},
"entity": {
"type": "string",
"description": "Required entity name for which to subscribe.Enum: ORDERS SHIPMENTS",
"enum": [
"SHIPMENTS",
"ORDERS",
"INBOUNDS",
"RETURNS",
"INVOICES"
]
},
"endpoint": {
"$ref": "#/components/schemas/EndpointGet"
},
"uuid": {
"type": "string"
}
}
},
"SubscriptionPackageConfigSummary": {
"type": "object",
"properties": {
"subscriptionPackage": {
"type": "string",
"enum": [
"RISING_STAR",
"STELLAR_EXPLORER",
"FULFILLED_LEGEND",
"WITHOUT_PACKAGE",
"SEND_IT_YOURSELF",
"CUSTOMIZED"
]
},
"allowedArticles": {
"type": "integer",
"format": "int32"
},
"allowedShops": {
"type": "integer",
"format": "int32"
}
}
},
"SubscriptionPost": {
"required": [
"endpoint",
"entity",
"sellerId"
],
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"description": "Required seller for which to make a subscription.",
"format": "int64"
},
"entity": {
"type": "string",
"description": "Required entity name for which to subscribe.Enum: ORDERS SHIPMENTS",
"enum": [
"SHIPMENTS",
"ORDERS",
"INBOUNDS",
"RETURNS",
"INVOICES"
]
},
"endpoint": {
"$ref": "#/components/schemas/EndpointGet"
}
}
},
"TrackingDetailGet": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"created": {
"type": "string",
"format": "date-time"
},
"message": {
"type": "string"
},
"rawTag": {
"type": "string"
}
}
},
"TrackingSummary": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "The tracking number for the shipment."
},
"link": {
"type": "string",
"description": "The public tracking link URL provided by the carrier."
}
},
"description": "Provides a summary of a shipment's tracking details, including the tracking number and the corresponding public tracking link."
},
"TransportGet": {
"required": [
"positions",
"sellerId",
"shipFrom",
"shipTo"
],
"type": "object",
"properties": {
"shipTo": {
"$ref": "#/components/schemas/AddressData"
},
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"pickupDate": {
"type": "string",
"description": "Optional estimated date of departure",
"format": "date"
},
"deliveryDate": {
"type": "string",
"description": "Optional estimated date of arrival",
"format": "date"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressData"
},
"positions": {
"type": "array",
"description": "List of the positions for transportation.",
"items": {
"$ref": "#/components/schemas/TransportPositionData"
}
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"reference": {
"type": "string"
},
"exportedAt": {
"type": "string",
"format": "date-time"
},
"status": {
"type": "string",
"enum": [
"CREATED",
"TRANSMITTED"
]
},
"freightOrderIdentifier": {
"type": "string"
},
"requestId": {
"type": "string"
}
}
},
"TransportPositionData": {
"required": [
"contentDescription",
"deliveryType",
"quantity",
"unitHeightM",
"unitLengthM",
"unitWeightKg",
"unitWidthM"
],
"type": "object",
"properties": {
"deliveryType": {
"type": "string",
"description": "Delivery type.",
"enum": [
"CONTAINER",
"CARTON",
"EUPAL",
"EWPAL"
]
},
"containerType": {
"type": "string",
"description": "Type of the container.
Required only if delivery type is CONTAINER"
},
"quantity": {
"minimum": 1,
"type": "integer",
"description": "Number of units of the position.",
"format": "int32"
},
"unitWeightKg": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Weight in kg per unit."
},
"unitLengthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Length in meters per unit."
},
"unitWidthM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Width in meters per unit."
},
"unitHeightM": {
"minimum": 0,
"exclusiveMinimum": true,
"type": "number",
"description": "Height in meters per unit."
},
"contentDescription": {
"type": "string",
"description": "Name or short description of a position."
}
}
},
"TransportPost": {
"required": [
"positions",
"sellerId",
"shipFrom",
"shipTo"
],
"type": "object",
"properties": {
"shipTo": {
"$ref": "#/components/schemas/AddressData"
},
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"pickupDate": {
"type": "string",
"description": "Optional estimated date of departure",
"format": "date"
},
"deliveryDate": {
"type": "string",
"description": "Optional estimated date of arrival",
"format": "date"
},
"shipFrom": {
"$ref": "#/components/schemas/AddressData"
},
"positions": {
"type": "array",
"description": "List of the positions for transportation.",
"items": {
"$ref": "#/components/schemas/TransportPositionData"
}
}
}
},
"TransportPostResult": {
"type": "object",
"properties": {
"status": {
"type": "string"
},
"transportId": {
"type": "integer",
"format": "int64"
}
}
},
"TransportSummary": {
"required": [
"sellerId",
"shipTo"
],
"type": "object",
"properties": {
"shipTo": {
"$ref": "#/components/schemas/AddressData"
},
"sellerId": {
"type": "integer",
"description": "Seller ID.",
"format": "int64"
},
"pickupDate": {
"type": "string",
"description": "Optional estimated date of departure",
"format": "date"
},
"deliveryDate": {
"type": "string",
"description": "Optional estimated date of arrival",
"format": "date"
},
"id": {
"type": "integer",
"format": "int64"
},
"created": {
"type": "string",
"format": "date-time"
},
"reference": {
"type": "string"
},
"status": {
"type": "string",
"enum": [
"CREATED",
"TRANSMITTED"
]
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
}
}
},
"VerifyReturnShipmentLinkResponse": {
"type": "object",
"properties": {
"sellerId": {
"type": "integer",
"format": "int64"
},
"sellerName": {
"type": "string"
},
"defaultWeightKG": {
"type": "number"
},
"weightInputVisible": {
"type": "boolean"
},
"countries": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ReturnAppCountry"
}
},
"carrierSlug": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"shippingServices": {
"uniqueItems": true,
"type": "array",
"items": {
"type": "string"
}
},
"sellerLogo": {
"$ref": "#/components/schemas/Link"
}
}
},
"WarehouseAddress": {
"required": [
"city",
"countryIso2",
"street"
],
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the person.
Usually this is the first and last name."
},
"company": {
"type": "string",
"description": "Name of the company."
},
"phone": {
"type": "string",
"description": "Phone number.
The phone number is usually optional."
},
"email": {
"type": "string",
"description": "E-Mail address."
},
"zip": {
"type": "string",
"description": "ZIP Code.
The ZIP code is optional for some countries, but required for most."
},
"city": {
"type": "string",
"description": "City.
The city should always be specified."
},
"state": {
"type": "string",
"description": "State.
This is not required for most countries, but required in some (eg: United States)."
},
"countryIso2": {
"type": "string",
"description": "Country.
The country should always be specified."
},
"street": {
"type": "string",
"description": "Street (or Address Line 1).
This field should always be specified."
},
"street2": {
"type": "string",
"description": "Street (or Address Line 2).
This field is optional."
}
}
},
"WarehouseSummary": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"format": "int64"
},
"name": {
"type": "string"
},
"warehouseAddress": {
"$ref": "#/components/schemas/WarehouseAddress"
},
"deactivatedAt": {
"type": "string",
"format": "date-time"
},
"sort": {
"$ref": "#/components/schemas/JsonNode"
},
"sellerIdForCartons": {
"type": "integer",
"format": "int64"
},
"managingGroup": {
"type": "string",
"enum": [
"QUIVO",
"GWC"
]
},
"legalEntityId": {
"type": "integer",
"format": "int64"
}
}
},
"WeightDetail": {
"type": "object",
"properties": {
"value": {
"type": "number"
},
"unit": {
"type": "string",
"enum": [
"KG",
"G",
"LB",
"OZ"
]
}
}
}
}
},
"x-original-swagger-version": "2.0"
}