{ "openapi": "3.0.0", "info": { "title": "Intrasistema REST API v1", "description": "Enterprise omnichannel eCommerce, Warehouse Management (WMS), and Logistics fulfillment platform. All requests require authentication via the `X-API-KEY` HTTP header.\\n\\nMachine-readable AI & LLMs context: [https://api.intrasistema.com/llms.txt](https://api.intrasistema.com/llms.txt)", "termsOfService": "https://static.intrasistema.com/documents/terms-of-use.html", "contact": { "name": "Developer Support", "url": "https://intrasistema.com", "email": "api@intrasistema.com" }, "license": { "name": "Proprietary", "url": "https://static.intrasistema.com/documents/terms-of-use.html" }, "version": "1.0.0b" }, "servers": [ { "url": "https://api.intrasistema.com", "description": "Production Host" } ], "paths": { "/v1/automation/{business_id}/items/pricing/rules/create": { "post": { "tags": [ "Automation" ], "summary": "Create new rule", "operationId": "automation-items-pricing-rules-create", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "position_id": { "type": "integer" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "position_id": { "type": "string" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" }, "id": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "201": { "description": "Fields with errors", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/automation/{business_id}/items/pricing/rules/{rule_id}/delete": { "delete": { "tags": [ "Automation" ], "summary": "Delete rule by ID", "operationId": "automation-items-pricing-rules-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "rule_id", "in": "path", "description": "target rule ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "position_id": { "type": "string" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" }, "id": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "201": { "description": "Fields with errors", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/automation/{business_id}/items/pricing/rules/{rule_id}/edit": { "put": { "tags": [ "Automation" ], "summary": "Edit rule by ID", "operationId": "automation-items-pricing-rules-edit", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "rule_id", "in": "path", "description": "target rule ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "position_id": { "type": "integer" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "position_id": { "type": "string" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" }, "id": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "201": { "description": "Fields with errors", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/automation/{business_id}/items/pricing/rules/jobs/execute": { "post": { "tags": [ "Automation" ], "summary": "Execute a job for pricing rules", "operationId": "automation-items-pricing-rules-create_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "position_id": { "type": "integer" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "position_id": { "type": "string" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" }, "id": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "201": { "description": "Fields with errors", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/automation/{business_id}/items/pricing/rules/list": { "get": { "tags": [ "Automation" ], "summary": "List rules", "operationId": "items-pricing-rules-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "position_id": { "type": "string" }, "origin_price_list_id": { "type": "integer" }, "target_price_list_id": { "type": "integer" }, "origin_action_id": { "type": "string" }, "origin_action_value": { "type": "string" }, "condition_id": { "type": "string" }, "condition_value": { "type": "string" }, "status": { "type": "integer" }, "id": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/automation/{business_id}/items/pricing/rules/position": { "put": { "tags": [ "Automation" ], "summary": "Move rule order position by rule id", "operationId": "users-put-device", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "position_id": { "type": "integer" } }, "type": "object" } } }, "type": "object" } } } }, "201": { "description": "Fields with errors", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api token supplied" }, "429": { "description": "Rate limit exceeded", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": "1" }, "message": { "type": "string", "example": "Rate limit exceeded, try again in 10 seconds" } }, "type": "object" } } } }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/business/{business_id}": { "get": { "tags": [ "Business" ], "summary": "Retrieve business configuration", "operationId": "business-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/business/my": { "get": { "tags": [ "Business" ], "summary": "Get my business ids", "operationId": "business-get_2", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/business/my/warehouses": { "get": { "tags": [ "Business" ], "summary": "Get my warehouses availables", "operationId": "business-get_3", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/business/{business_id}/warehouses": { "get": { "tags": [ "Business" ], "summary": "Get warehouses list", "operationId": "business-warehouse-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "is_visible_sales", "in": "query", "description": "Filter by pick_up flag", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/buyers/{business_id}/find/{key_type}": { "get": { "tags": [ "Buyers" ], "summary": "Find item", "operationId": "buyer-find", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the instance to search in", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "Key type (by_name, by_id, by_wildcard)", "required": true, "schema": { "type": "string" } }, { "name": "key_id", "in": "query", "description": "Key content to search", "required": true, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/contact/{business_id}/{form_id}": { "post": { "tags": [ "Contact Form" ], "summary": "Send message to a specified department member of any business_id", "operationId": "contact-form", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "form_id", "in": "path", "description": "form id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/threads/list": { "get": { "tags": [ "Crm" ], "summary": "List messages by status", "operationId": "mail-list-messages", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/threads/{thread_id}/message": { "post": { "tags": [ "Crm" ], "summary": "Post new message to an existing thread", "operationId": "crm-message-thread-post", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "thread_id", "in": "path", "description": "Thread ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "thread": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/threads/messages/{thread_id}": { "get": { "tags": [ "Crm" ], "summary": "Get message by thread id", "operationId": "crm-message-thread-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "thread_id", "in": "path", "description": "Thread ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "thread": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/Message" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/threads/{thread_id}/tags": { "post": { "tags": [ "Crm" ], "summary": "Get tags from thread", "operationId": "crm-thread-tags-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "thread_id", "in": "path", "description": "Thread ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "Thread-Tags": { "type": "array", "items": { "$ref": "#/components/schemas/Thread-Tags" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/messages/list": { "get": { "tags": [ "Crm" ], "summary": "List messages by status", "operationId": "crm-phone-task-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/phone/extension/my": { "get": { "tags": [ "Crm" ], "summary": "Get my assigned extension", "operationId": "crm-phone-extension-my-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/phone/task/{task_id}/call/{extension}": { "post": { "tags": [ "Crm" ], "summary": "Make a call to a phone number from phone task", "operationId": "crm-phone-task-call-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "task_id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "extension", "in": "path", "description": "extension number to transfer the call", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/phone/task/list": { "get": { "tags": [ "Crm" ], "summary": "List phone tasks", "operationId": "crm-phone-task-get_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/phone/task": { "post": { "tags": [ "Crm" ], "summary": "Post new task to the work queue (typical callback)", "operationId": "crm-phone-task-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/phone/task/{task_id}": { "put": { "tags": [ "Crm" ], "summary": "Edit phone task", "operationId": "crm-phone-task-put", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "task_id", "in": "path", "description": "Task ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/whatsapp/message/{session_id}": { "post": { "tags": [ "Crm" ], "summary": "Post message to an existing chat session", "operationId": "crm-whatsapp-message-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "session_id", "in": "path", "description": "Specify claim_id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/whatsapp/list": { "get": { "tags": [ "Crm" ], "summary": "List messages by status", "operationId": "whatsapp-messages-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/whatsapp/session/{session_id}/await": { "post": { "tags": [ "Crm" ], "summary": "Post chat session in waiting for reply mode", "operationId": "crm-whatsapp-session-await", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "session_id", "in": "path", "description": "Specify session_id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/session/{session_id}/close/{reason_id}": { "put": { "tags": [ "Crm" ], "summary": "Post message template", "operationId": "crm-whatsapp-session-close", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "session_id", "in": "path", "description": "Specify session_id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "reason_id", "in": "path", "description": "Close reason ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/crm/{business_id}/whatsapp/template/{template_id}": { "post": { "tags": [ "Crm" ], "summary": "Post message template", "operationId": "crm-whatsapp-template-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "template_id", "in": "path", "description": "Template ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/customers/{business_id}/stats/{customer_id}": { "get": { "tags": [ "Customers" ], "summary": "Obtain customers stats by customer ID", "operationId": "customers-stats-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "customer_id", "in": "path", "description": "Customer ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/dashboards/{business_id}/{dashboard_id}/iframe": { "get": { "tags": [ "Dashboards" ], "summary": "Get dashboard html iframe to embbed in your UI", "operationId": "011697433a4dbaa34704fe6576478e8b", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number id", "required": true, "schema": { "type": "integer" } }, { "name": "dashboard_id", "in": "path", "description": "Dashboard internal number", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/documents/{business_id}/{relation_type}/categories": { "get": { "tags": [ "Documents" ], "summary": "Get categories of documents by relation type", "operationId": "documents-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_type", "in": "path", "description": "Relation type (order, inbound, etc)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/documents/{business_id}/{relation_type}/{relation_id}/list": { "get": { "tags": [ "Documents" ], "summary": "Get documents associated with a order, inbound, outbound or customer", "operationId": "documents-list_2", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_type", "in": "path", "description": "Relation type (order, inbound, etc)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_id", "in": "path", "description": "Relation identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter type", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/documents/{business_id}/{relation_type}/{relation_id}/onvif/{resource_type}/{resource_id}": { "post": { "tags": [ "Documents" ], "summary": "Capture an onvif image, save to documents and get image base64 encoded", "operationId": "documents-post-onvif-image", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_type", "in": "path", "description": "Relation type (order, inbound, etc)", "required": true, "schema": { "type": "string" } }, { "name": "relation_id", "in": "path", "description": "Relation ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "resource_type", "in": "path", "description": "Resource type (camera, scanner, etc)", "required": true, "schema": { "type": "string" } }, { "name": "resource_id", "in": "path", "description": "Resource ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/documents/{business_id}/{relation_type}/{relation_id}/{file_name}": { "post": { "tags": [ "Documents" ], "summary": "Upload and associate a document to a relation", "operationId": "documents-list_3", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_type", "in": "path", "description": "Relation type (order, inbound, etc)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_id", "in": "path", "description": "Relation identifier", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "file_name", "in": "path", "description": "File name", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/fbm/{business_id}/prints/{order_id}/zpl": { "get": { "tags": [ "Fulfillment" ], "summary": "Get ZPL labels for an order in a zip file", "operationId": "fbm-prints-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Specify order_id destination", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/fbm/{business_id}/orders/list": { "get": { "tags": [ "Fulfillment" ], "summary": "List orders by status", "operationId": "fbm-orders-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/fbm/{business_id}/prints/{order_id}/{desk_id}": { "get": { "tags": [ "Fulfillment" ], "summary": "Send automatic print label to work desk via internal socket", "operationId": "fbm-prints-get_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Specify order_id destination", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "desk_id", "in": "path", "description": "Desk ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/images/delete/{image_id}": { "post": { "tags": [ "Images" ], "summary": "Delete image by ID", "operationId": "image-delete", "parameters": [ { "name": "image_id", "in": "path", "description": "Image ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Inbounds" ], "summary": "Get inbound item by keytype", "operationId": "inbounds-items-find", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}": { "get": { "tags": [ "Inbounds" ], "summary": "Get inbound order", "operationId": "inbounds-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] }, "put": { "tags": [ "Inbounds" ], "summary": "Edit inbound order details", "operationId": "inbounds-put-order", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "inbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Inbounds" ], "summary": "Delete inbound order", "operationId": "inbounds-orders_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "inbound order id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/items": { "post": { "tags": [ "Inbounds" ], "summary": "Post items array to an inbound order (bulk)", "operationId": "inbounds-items-post-items", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "inbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/item/{item_id}": { "put": { "tags": [ "Inbounds" ], "summary": "Post item to an inbound order", "operationId": "inbounds-items-put-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID target to change quantity", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "inbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Inbounds" ], "summary": "Delete item in inbound order", "operationId": "inbounds-items-delete-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "description": "Array of JSON objects with error = 0", "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/list": { "get": { "tags": [ "Inbounds" ], "summary": "Get inbound items by inbound order id", "operationId": "inbouds-items-list-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/item": { "post": { "tags": [ "Inbounds" ], "summary": "Post item to an inbound order", "operationId": "inbounds-items-post-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "inbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order": { "post": { "tags": [ "Inbounds" ], "summary": "Post a inbound header order to get receive it in a warehouse", "operationId": "inbounds-orders_3", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/order/{order_id}/status/{status_id}": { "put": { "tags": [ "Inbounds" ], "summary": "Change status of inbound order", "operationId": "inbounds-order-status-put", "parameters": [ { "name": "business_id", "in": "path", "description": "business id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "status (open, close)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{business_id}/orders/list": { "get": { "tags": [ "Inbounds" ], "summary": "List inbound orders by status", "operationId": "inbouds-list-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{warehouse_id}/order/putaway/{order_id}/item/{item_id}": { "post": { "tags": [ "Inbounds" ], "summary": "Post item to storage", "operationId": "inbounds-putaway-order-item", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id destination", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "item id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inbounds/{warehouse_id}/order/receive/{order_id}/item/{item_id}": { "post": { "tags": [ "Inbounds" ], "summary": "Post a inbound order to get receive it in a warehouse", "operationId": "inbounds-receive-order-item", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id destination", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "item id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Inbounds" ], "summary": "Delete an received inbound item line", "operationId": "inbounds-receive-order-item-delete", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id destination", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "item id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/item": { "post": { "tags": [ "Inbounds" ], "summary": "Post item to an outbound order", "operationId": "outbounds-items-post-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Inbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "outbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/utilities/scan/{scan_type}": { "post": { "tags": [ "Inbounds" ], "summary": "Get route by scan data", "operationId": "utilities-scan-get", "parameters": [ { "name": "scan_type", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/integrations/{business_id}/command/send": { "post": { "tags": [ "Integrations" ], "summary": "Send a command to an order integration", "operationId": "integrations-orders-command-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/config/create": { "post": { "tags": [ "Integrations" ], "summary": "Create or upsert integration config", "operationId": "integrations-config-create", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/config/delete/{config_id}": { "delete": { "tags": [ "Integrations" ], "summary": "Delete integration config by ID", "operationId": "integrations-config-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "config_id", "in": "path", "description": "config id to delete", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/config/edit/{config_id}": { "put": { "tags": [ "Integrations" ], "summary": "Edit integration config value by ID", "operationId": "integrations-config-edit", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "config_id", "in": "path", "description": "config id to edit", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad request" }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/config/keys": { "get": { "tags": [ "Integrations" ], "summary": "List available configuration keys and integrations catalog", "operationId": "integrations-config-keys-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/config/list": { "get": { "tags": [ "Integrations" ], "summary": "List integrations config for a specific business", "operationId": "integrations-config-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the configuration", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by integration_id or category/type", "required": false, "schema": { "type": "string" } }, { "name": "value_type", "in": "query", "description": "Filter by value_type (boolean, int, string, json)", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Business required" }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/credentials/list": { "get": { "tags": [ "Integrations" ], "summary": "List integrations credentials", "operationId": "integrations-credentials-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/bulk-action": { "post": { "tags": [ "Integrations" ], "summary": "Execute bulk operations on multiple error records", "operationId": "integrations-errors-bulk-action", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "action": { "type": "string", "example": "retry", "enum": [ "retry", "force", "ignore", "reopen", "resolve" ] }, "ids": { "type": "array", "items": { "type": "integer" } }, "notes": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Bulk execution summary", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/{error_id}/force": { "post": { "tags": [ "Integrations" ], "summary": "Force synchronization for an error record", "operationId": "integrations-errors-force", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "error_id", "in": "path", "description": "Error record ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Forced synchronization result", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/{error_id}": { "get": { "tags": [ "Integrations" ], "summary": "Get integration error details and diagnosis", "operationId": "integrations-errors-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "error_id", "in": "path", "description": "Error record ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Error not found" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/list": { "get": { "tags": [ "Integrations" ], "summary": "List synchronization and integrity errors", "operationId": "integrations-errors-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID owner of the integration errors", "required": true, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Filter by status (pending_remediation, remediated, ignored, all)", "required": false, "schema": { "type": "string" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "integer" } }, { "name": "resource_type", "in": "query", "description": "Filter by resource type (order, item, shipment)", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by resource ID, seller ID, error message, or integration", "required": false, "schema": { "type": "string" } }, { "name": "date_from", "in": "query", "description": "Start date (YYYY-MM-DD)", "required": false, "schema": { "type": "string" } }, { "name": "date_to", "in": "query", "description": "End date (YYYY-MM-DD)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/{error_id}/retry": { "post": { "tags": [ "Integrations" ], "summary": "Retry synchronization for an error record", "operationId": "integrations-errors-retry", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "error_id", "in": "path", "description": "Error record ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Synchronization result", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/{error_id}/status": { "put": { "tags": [ "Integrations" ], "summary": "Update status and notes of an error record", "operationId": "integrations-errors-status-put", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "error_id", "in": "path", "description": "Error record ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "example": "ignored" }, "notes": { "type": "string", "example": "Descartado por cancelación previa" } }, "type": "object" } } } }, "responses": { "200": { "description": "Status updated successfully", "content": { "application/json": { "schema": { "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/errors/summary": { "get": { "tags": [ "Integrations" ], "summary": "Get integration errors KPI summary", "operationId": "integrations-errors-summary", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Unauthorized" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/credentials/{credential_id}/publications/import": { "post": { "tags": [ "Integrations" ], "summary": "Import remote publication into Intrasistema catalog", "operationId": "integrations-external-publications-import", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID owner of the integration", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "credential_id", "in": "path", "description": "Credential ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "external_id": { "description": "Remote publication external ID", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/credentials/{credential_id}/publications": { "get": { "tags": [ "Integrations" ], "summary": "List remote publications from an integration credential", "operationId": "integrations-external-publications-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID owner of the integration", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "credential_id", "in": "path", "description": "Credential ID to fetch products from", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "page", "in": "query", "description": "Page number", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "perPage", "in": "query", "description": "Items per page", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "status", "in": "query", "description": "Publication status filter (e.g. active, paused, all)", "required": false, "schema": { "type": "string", "enum": [ "active", "paused", "all" ] } } ], "responses": { "200": { "description": "Successful operation" }, "400": { "description": "Invalid parameters or credential" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/inventories/list": { "get": { "tags": [ "Integrations" ], "summary": "List all items with channel inventory for a business", "operationId": "integrations-inventories-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID (1=Mercado Libre, 3=Amazon)", "required": false, "schema": { "type": "integer" } }, { "name": "filter_id", "in": "query", "description": "Filter: all, with_stock, out_of_stock, has_damaged, has_not_supported", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by SKU, title, MLA, or inventory_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Paginated list of channel inventory items" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/items/{item_id}/inventory/operations": { "get": { "tags": [ "Integrations" ], "summary": "List stock operations in integration warehouses (MELI Full, Amazon FBA)", "operationId": "integrations-items-inventory-operations-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID (SKU)", "required": true, "schema": { "type": "integer" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID (1=Mercado Libre, 3=Amazon)", "required": false, "schema": { "type": "integer" } }, { "name": "inventory_id", "in": "query", "description": "Filter by specific inventory ID", "required": false, "schema": { "type": "string" } }, { "name": "dateFrom", "in": "query", "description": "Start date (YYYY-MM-DD)", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "End date (YYYY-MM-DD)", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by shipment_id or operation_type", "required": false, "schema": { "type": "string" } }, { "name": "limitFrom", "in": "query", "description": "Pagination offset", "required": false, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Pagination limit", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "List of stock operations in channel warehouses" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/items/{item_id}/inventory/snapshot": { "get": { "tags": [ "Integrations" ], "summary": "Get item inventory snapshot in integration warehouses (MELI Full, Amazon FBA)", "operationId": "integrations-items-inventory-snapshot-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID (SKU)", "required": true, "schema": { "type": "integer" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID (1=Mercado Libre, 3=Amazon). If omitted, returns all channels.", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Integration inventory snapshot details" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/items/{item_id}/inventory/sync": { "post": { "tags": [ "Integrations" ], "summary": "Trigger on-demand live synchronization of channel inventory and replicate into internal warehouse", "operationId": "integrations-items-inventory-sync-post", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID (SKU)", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Sync result and updated stock snapshot" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/list": { "get": { "tags": [ "Integrations" ], "summary": "List integrations available", "operationId": "integrations-list", "parameters": [ { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "id": { "type": "string" }, "integration": { "type": "string" }, "type": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" } }, "type": "object" } }, "recordsTotal": { "type": "string" }, "recordsFiltered": { "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/ai-autofill": { "post": { "tags": [ "Integrations" ], "summary": "Auto-fill missing publication required attributes using Gemini AI", "operationId": "integrations-migration-ai-autofill-post", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID (credential_id)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "items": { "description": "List of items with required_attributes to fill", "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Attributes auto-filled successfully" }, "400": { "description": "Invalid parameters or missing items array" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/charts/{chart_id}": { "get": { "tags": [ "Integrations" ], "summary": "Get specific size chart details from Mercado Libre by chart ID", "operationId": "integrations-migration-chart-get", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID (credential_id)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "chart_id", "in": "path", "description": "Mercado Libre Size Chart ID (ej: 232382)", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Size chart details retrieved successfully" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/charts": { "post": { "tags": [ "Integrations" ], "summary": "Get seller size charts (guías de talles) for a domain and attributes", "operationId": "integrations-migration-charts-post", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID (credential_id)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "domain_id": { "type": "string", "example": "SNEAKERS" }, "attributes": { "type": "object", "example": { "GENDER": "Mujer", "BRAND": "Adidas" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Size charts retrieved successfully" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/official-stores": { "get": { "tags": [ "Integrations" ], "summary": "Get official stores for a destination credential", "operationId": "integrations-migration-official-stores-get", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/prepare": { "post": { "tags": [ "Integrations" ], "summary": "Prepare and parse source publication data for destination credential migration", "operationId": "integrations-migration-prepare-post", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID (dest_credential_id)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "src_credential_id": { "description": "Source Credential ID", "type": "integer", "example": 82 }, "items": { "description": "List of source items to convert", "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Data parsed and prepared successfully" }, "400": { "description": "Invalid parameters or credential missing" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/publication": { "post": { "tags": [ "Integrations" ], "summary": "Publish a single item to the destination integration", "operationId": "integrations-migration-publication-post", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID (credential_id)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "item": { "description": "Item payload prepared from previous steps", "type": "object" } }, "type": "object" } } } }, "responses": { "200": { "description": "Item published successfully" }, "400": { "description": "Invalid parameters or missing item" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/migration/{credential_id}/shipping-modes": { "get": { "tags": [ "Integrations" ], "summary": "Get available shipping modes for a destination credential", "operationId": "integrations-migration-shipping-modes-get", "parameters": [ { "name": "credential_id", "in": "path", "description": "Destination Credential ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/{order_id}/mercadolibre": { "get": { "tags": [ "Integrations" ], "summary": "Get comprehensive Mercado Libre order & shipment details", "operationId": "integrations-orders-mercadolibre-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Mercado Libre details for the order" }, "401": { "description": "Unauthorized" }, "404": { "description": "Order not found" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/orders/sync/list": { "get": { "tags": [ "Integrations" ], "summary": "List orders by status integration", "operationId": "integrations-orders-sync-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/orders/marketplace": { "post": { "tags": [ "Integrations" ], "summary": "Synchronize order from marketplace by id", "operationId": "integrations-orders-marketplace-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/payments/sync/list": { "get": { "tags": [ "Integrations" ], "summary": "List payments transactions by status integration", "operationId": "integrations-payments-sync-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/pricelists/equivalencies/create": { "post": { "tags": [ "Integrations" ], "summary": "Create new equivalency pricelist connection", "operationId": "integrations-pricelist-equivalencies-create", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/pricelists/equivalencies/delete/{equivalency_id}": { "delete": { "tags": [ "Integrations" ], "summary": "Delete equivalency by ID", "operationId": "integrations-pricelists-equivalencies-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "equivalency_id", "in": "path", "description": "equivalency id to delete", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/pricelists/equivalencies/edit/{equivalency_id}": { "put": { "tags": [ "Integrations" ], "summary": "Edit equivalency by ID", "operationId": "integrations-pricelists-equivalencies-edit", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "equivalency_id", "in": "path", "description": "equivalency id to edit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/pricelists/equivalencies/list": { "get": { "tags": [ "Integrations" ], "summary": "List equivalencies of integrations pricelists", "operationId": "integrations-pricelists-equivalencies-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/pricelists/integrations/list": { "get": { "tags": [ "Integrations" ], "summary": "List pricelists imported from integrations", "operationId": "integrations-pricelists-integrations-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/stocks/integrations/list": { "get": { "tags": [ "Integrations" ], "summary": "List stocks imported from integrations", "operationId": "integrations-pricelists-integrations-list_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/warehouses/equivalencies/create": { "post": { "tags": [ "Integrations" ], "summary": "Create new equivalency warehouse connection", "operationId": "integrations-warehouses-equivalencies-create", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/warehouses/equivalencies/delete/{equivalency_id}": { "delete": { "tags": [ "Integrations" ], "summary": "Delete equivalency by ID", "operationId": "integrations-warehouses-equivalencies-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "equivalency_id", "in": "path", "description": "equivalency id to edit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/warehouses/equivalencies/edit/{equivalency_id}": { "put": { "tags": [ "Integrations" ], "summary": "Edit equivalency by ID", "operationId": "integrations-warehouses-equivalencies-edit", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "equivalency_id", "in": "path", "description": "equivalency id to edit", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/warehouses/integrations/list": { "get": { "tags": [ "Integrations" ], "summary": "List warehouses imported from integrations", "operationId": "integrations-warehouses-integrations-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/warehouses/equivalencies/list": { "get": { "tags": [ "Integrations" ], "summary": "List equivalencies of integrations warehouses", "operationId": "integrations-warehouses-equivalencies-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/integrations/{business_id}/wms/list": { "get": { "tags": [ "Integrations" ], "summary": "List wms data from integration", "operationId": "integrations-wms-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic_id", "required": false, "schema": { "type": "string" } }, { "name": "searchText", "in": "query", "description": "Search by phrase", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inventory/{business_id}/item/list": { "get": { "tags": [ "Inventory" ], "summary": "List item controls", "operationId": "inventory-item-control-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/inventory/{warehouse_id}/item/{item_id}": { "post": { "tags": [ "Inventory" ], "summary": "Post item control review", "operationId": "inventory-items-control-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "business number owner of the item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/inventory/{business_id}/item/{item_id}/{control_id}": { "put": { "tags": [ "Inventory" ], "summary": "Put item status control", "operationId": "inventory-items-control-status-put", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "control_id", "in": "path", "description": "Control ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/inventory/{warehouse_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Inventory" ], "summary": "Get item stock, location by keytype", "operationId": "inventory-items-find", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/{business_id}/{item_id}/activate": { "put": { "tags": [ "Items" ], "summary": "Activate item on all channels", "operationId": "items-activate-put", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/attributes/meta/create": { "post": { "tags": [ "Items" ], "summary": "Insert a meta attribute to an item", "operationId": "items-attributes-meta-create", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/attributes/meta/{attribute_id}": { "delete": { "tags": [ "Items" ], "summary": "Delete an existing meta attribute", "operationId": "items-attributes-meta-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "attribute_id", "in": "path", "description": "Attribute ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/attributes/meta/keys/list": { "get": { "tags": [ "Items" ], "summary": "Get available meta attributes keys", "operationId": "inbounds-items-attributes-meta-keys-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/attributes/meta/list": { "get": { "tags": [ "Items" ], "summary": "Get item meta attributes", "operationId": "inbounds-items-attributes-meta-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/codes/create": { "post": { "tags": [ "Items" ], "summary": "Create an item identifier code (barcode, erp, supplier)", "operationId": "items-codes-create", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Payload to create an item code", "required": true, "content": { "application/json": { "schema": { "properties": { "code": { "description": "Code string (empty for barcode to auto-generate UID)", "type": "string" }, "code_class": { "description": "Code class: barcode, erp or supplier (default: barcode)", "type": "string", "enum": [ "barcode", "erp", "supplier" ] }, "code_multiplier": { "description": "Units represented by the code (1 to 10000, default: 1)", "type": "integer" }, "code_unit_id": { "description": "Presentation unit (unit, pack, box, pallet, default: unit)", "type": "string" }, "is_scannable": { "description": "1 if code is scannable (erp/supplier only, default: 0)", "type": "integer", "enum": [ 0, 1 ] }, "force": { "description": "1 to force invalid barcode as custom (barcode only, default: 0)", "type": "integer", "enum": [ 0, 1 ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "0 for success, 1 for errors", "type": "integer" }, "message": { "description": "Status description", "type": "string" }, "id": { "description": "ID of the created code in item_codes", "type": "integer", "nullable": true } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/codes/{identifier_id}": { "delete": { "tags": [ "Items" ], "summary": "Delete an existing meta attribute", "operationId": "items-codes-delete", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the item", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "identifier_id", "in": "path", "description": "Identifier ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/codes/list": { "get": { "tags": [ "Items" ], "summary": "Get item codes (ean, upc, barcode, etc)", "operationId": "inbounds-items-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/delete": { "delete": { "tags": [ "Items" ], "summary": "Delete item", "operationId": "items-delete-del", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/find/{key_type}": { "get": { "tags": [ "Items" ], "summary": "Find item", "operationId": "items-find", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the instance to search in", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "Key type (by_title, by_id, by_wildcard)", "required": true, "schema": { "type": "string" } }, { "name": "key_id", "in": "query", "description": "Key content to search", "required": true, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID (inbound_acceptable)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "results": { "type": "array", "items": { "$ref": "#/components/schemas/Item" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/gallery": { "get": { "tags": [ "Items" ], "summary": "Get gallery images for item", "operationId": "item-gallery-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/{business_id}/find/integration/{integration_id}/{integration_item_id}/{variation_id}": { "get": { "tags": [ "Items" ], "summary": "Get item ID by integration item ID", "operationId": "item-get-by-integration-id", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "integration_id", "in": "path", "description": "Integration ID, 1 for Mercado Libre, 2 for Shopify, 3 for Prestashop, 4 for Tienda Icbc, etc", "required": true, "schema": { "type": "integer" } }, { "name": "integration_item_id", "in": "path", "description": "Item identifier in integration, e.g. MELI: MLA123456789", "required": true, "schema": { "type": "integer" } }, { "name": "variation_id", "in": "path", "description": "Variation, if item dont use variations, use 0", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/{business_id}/{item_id}/details": { "get": { "tags": [ "Items" ], "summary": "Obtain item full data (title, description, pricing, stock for sale, integrations, etc)", "operationId": "item-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/{business_id}/{item_id}": { "get": { "tags": [ "Items" ], "summary": "Obtain item details (title, description, pricing, stock for sale, etc)", "operationId": "item-get_2", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/{business_id}/list": { "get": { "tags": [ "Items" ], "summary": "List items", "operationId": "items-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/pause": { "put": { "tags": [ "Items" ], "summary": "Pause item on all channels", "operationId": "items-pause-put", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/audit/prices/list": { "get": { "tags": [ "Items" ], "summary": "Get audit log history for item price changes", "operationId": "orders-audit-price-log", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "item id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/{publication_id}/activate": { "put": { "tags": [ "Items" ], "summary": "Activate publicaction on integration site", "operationId": "items-publications-activate", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publication_id", "in": "path", "description": "Internal publication ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/{credential_id}/create": { "post": { "tags": [ "Items" ], "summary": "Create a new publication on integration site", "operationId": "items-publications-create", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "credential_id", "in": "path", "description": "Credential ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Optional customization parameters for Mercado Libre publication (category_id, price, available_quantity, title, attributes, etc.)", "required": false, "content": { "application/json": { "schema": { "properties": { "category_id": { "description": "Mercado Libre category ID (required if it cannot be predicted automatically)", "type": "string" }, "price": { "description": "Specific price for the publication", "type": "number", "format": "float" }, "price_list_id": { "description": "Price list ID to use when resolving item price (default: 1)", "type": "integer" }, "available_quantity": { "description": "Stock / available quantity for the publication", "type": "integer" }, "title": { "description": "Custom publication title (maximum 60 characters)", "type": "string" }, "attributes": { "type": "array", "items": { "properties": { "id": { "description": "Attribute ID, e.g. BRAND, MODEL, color, size, etc.", "type": "string" }, "value_name": { "description": "Value for the attribute", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "message": { "description": "Status / success message", "type": "string" }, "meli_item_id": { "description": "Mercado Libre Item ID (for integration_id = 1)", "type": "string" }, "publication": { "description": "Raw integration platform response object", "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code (e.g. 1)", "type": "integer" }, "message": { "description": "General error message", "type": "string" }, "validation_details": { "type": "array", "items": { "properties": { "error": { "description": "Specific validation error details", "type": "string" }, "field": { "description": "Field name or attribute ID with error", "type": "string" }, "title": { "description": "Human-readable title of the field", "type": "string" }, "description": { "description": "Detailed description or instruction to solve the error", "type": "string" }, "input_type": { "description": "UI input type suggestion (e.g., text, select, number)", "type": "string" }, "value_type": { "description": "Value type (e.g., string, integer, list)", "type": "string" }, "required": { "description": "Whether the field is required", "type": "boolean" }, "max_length": { "description": "Maximum value length if applicable", "type": "integer" }, "suggestions": { "type": "array", "items": { "description": "Suggested selectable values", "type": "object" } }, "group": { "description": "UI group/tab name for the field", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/{publication_id}": { "post": { "tags": [ "Items" ], "summary": "Associate a item to a external publication", "operationId": "items-publications-post", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publication_id", "in": "path", "description": "Credential or Publication ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Items" ], "summary": "Delete an association", "operationId": "items-publications-del", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publication_id", "in": "path", "description": "Internal publication ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/list": { "get": { "tags": [ "Items" ], "summary": "Get publications by item_id", "operationId": "items-publications-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/{publication_id}/pause": { "put": { "tags": [ "Items" ], "summary": "Pause publication on integration site", "operationId": "items-publications-pause", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publication_id", "in": "path", "description": "Internal publication ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/{business_id}/{item_id}/publications/{publication_id}/refresh": { "put": { "tags": [ "Items" ], "summary": "Force update publication in integration site", "operationId": "items-publications-refresh", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "publication_id", "in": "path", "description": "Internal publication ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/items/questions/{business_id}/{item_id}": { "get": { "tags": [ "Items" ], "summary": "Get questions from users to show in frontend carts", "operationId": "items-questions-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "SKU item", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/level/force/egress/{business_id}/{item_id}/{warehouse_id}": { "put": { "tags": [ "Items:Stock" ], "summary": "Force egress item without related order", "operationId": "items-stock-level-egress-put-force", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "SKU item", "required": true, "schema": { "type": "integer" } }, { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer" } }, { "name": "stock_type_id", "in": "query", "description": "Stock Type ID: 20 for reservations, 30 for physical", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/level/detail/{business_id}/{item_id}": { "get": { "tags": [ "Items:Stock" ], "summary": "Get stock level for specify sku", "operationId": "item-stock-level-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "SKU item", "required": true, "schema": { "type": "integer" } }, { "name": "limitFrom", "in": "query", "description": "Limit from (pagination), ex: 0", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Limit to (pagination), ex: 10", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/level/force/ingress/{business_id}/{item_id}/{warehouse_id}": { "put": { "tags": [ "Items:Stock" ], "summary": "Force ingress stock without related order", "operationId": "items-stock-level-ingress-put-force", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "SKU item", "required": true, "schema": { "type": "integer" } }, { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer" } }, { "name": "stock_type_id", "in": "query", "description": "Stock Type ID: 20 for reservations, 30 for physical", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/level/{business_id}/{item_id}": { "get": { "tags": [ "Items:Stock" ], "summary": "Get stock level list", "operationId": "item-stock-leve-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "SKU Item ID", "required": true, "schema": { "type": "integer" } }, { "name": "stock_type_id", "in": "query", "description": "Stock Type ID: 20 for reservations, 30 for physical", "required": true, "schema": { "type": "string" } }, { "name": "limitFrom", "in": "query", "description": "Limit from (pagination), ex: 0", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Limit to (pagination), ex: 10", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/operations/{business_id}/{item_id}/{warehouse_id}": { "get": { "tags": [ "Items:Stock" ], "summary": "List stock movements by date range with pagination", "description": "Returns stock movements (reservations or physical) for an item in a warehouse between two dates. Authentication via x-api-key header.", "operationId": "items-stock-get-movements", "parameters": [ { "name": "business_id", "in": "path", "description": "Business (tenant) ID that owns the item", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "description": "Item (SKU) ID", "required": true, "schema": { "type": "integer" } }, { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer" } }, { "name": "stockTypeId", "in": "query", "description": "Stock type: 20=reservations, 30=physical", "required": true, "schema": { "type": "integer", "enum": [ 20, 30 ] } }, { "name": "dateFrom", "in": "query", "description": "Start date and time (inclusive) in format 'YYYY-MM-DD HH:MM:SS'", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "dateTo", "in": "query", "description": "End date and time (inclusive) in format 'YYYY-MM-DD HH:MM:SS'", "required": true, "schema": { "type": "string", "format": "date-time" } }, { "name": "limitFrom", "in": "query", "description": "Pagination offset (from)", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Maximum number of records to return", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Array of stock movement records", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1234567 }, "item_id": { "type": "integer", "example": 70000 }, "business_id": { "type": "integer", "example": 99 }, "origin_type_id": { "description": "1=order, 4=adjustment, etc.", "type": "integer", "example": 1 }, "origin_id": { "type": "integer", "example": 10000000 }, "stock_type_id": { "type": "integer", "example": 30 }, "warehouse_id": { "type": "integer", "example": 5 }, "batch_id": { "type": "integer", "example": 12000 }, "qty": { "description": "Quantity (may be negative)", "type": "integer", "example": -5 }, "batch_balance": { "type": "integer", "example": 3 }, "balance": { "type": "integer", "example": 8 }, "comments": { "type": "string", "example": "Inventory adjustment | user@", "nullable": true }, "created_by": { "type": "integer", "example": 321, "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2025-10-24 11:59:02" }, "updated_at": { "type": "string", "nullable": true } }, "type": "object" } } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/v1/items/stock/ledger/{business_id}/{item_id}": { "get": { "tags": [ "Items:Stock" ], "summary": "Stock ledger (kardex) with balances and integrity check", "description": "Enriched movements for a period (origin, batch, user), per-warehouse opening/closing balances and running-balance integrity check (previous balance + qty = balance).", "operationId": "items-stock-ledger-get", "parameters": [ { "name": "business_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "stock_type_id", "in": "query", "description": "Stock type (20 reserved, 30 physical). Default 30", "required": false, "schema": { "type": "integer" } }, { "name": "warehouse_id", "in": "query", "description": "0 = all warehouses", "required": false, "schema": { "type": "integer" } }, { "name": "date_from", "in": "query", "description": "Y-m-d (default today - 30 days)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "date_to", "in": "query", "description": "Y-m-d (default today)", "required": false, "schema": { "type": "string", "format": "date" } }, { "name": "limit", "in": "query", "description": "Max movements (default 2000, max 5000)", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "{error, filters, summary, warehouses[], movements[]}" } }, "security": [ { "bearer": [] } ] } }, "/v1/items/stock/overview/{business_id}/{item_id}": { "get": { "tags": [ "Items:Stock" ], "summary": "Current stock snapshot per warehouse and active batches", "operationId": "items-stock-overview-get", "parameters": [ { "name": "business_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "item_id", "in": "path", "required": true, "schema": { "type": "integer" } }, { "name": "warehouse_id", "in": "query", "description": "Filters active batches", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "{error, snapshot[], warehouses[], batches[], generated_at}" } }, "security": [ { "bearer": [] } ] } }, "/v1/log/{business_id}/{relation_type}/{relation_id}/list": { "get": { "tags": [ "Log" ], "summary": "Get log entries by relation type and relation id", "operationId": "inbouds-list-orders_2", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_type", "in": "path", "description": "Relation type (order, inbound, etc)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "relation_id", "in": "path", "description": "ID of the relation", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/nps/{business_id}/record/{nps_type}": { "get": { "tags": [ "NPS" ], "summary": "Post a NPS qualification", "operationId": "nps-record", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "nps_type", "in": "path", "description": "NPS type", "required": true, "schema": { "type": "string" } }, { "name": "nps_value", "in": "query", "description": "NPS value", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "origin_id", "in": "query", "description": "Origin id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "origin_type", "in": "query", "description": "Origin type (Order, livechat, etc)", "required": true, "schema": { "type": "string" } }, { "name": "order_id", "in": "query", "description": "Order id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/network/ping": { "get": { "tags": [ "Network" ], "summary": "Ping API server", "operationId": "network-ping", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/operations/force/cancel": { "put": { "tags": [ "Orders" ], "summary": "Force cancel order", "operationId": "orders-operations-force-cancel", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "Call center has requested this change" }, "status_id": { "type": "string", "example": "PENDIENTE" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "0" }, "error_message": { "type": "string", "example": "Order status changed successfully." } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/operations/force/shipping/carrier": { "delete": { "tags": [ "Orders" ], "summary": "Force to delete carrier shipment order", "operationId": "orders-operations-force-shipping-delete-order", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "Call center has requested this change" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "0" }, "error_message": { "type": "string", "example": "Order error." } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/operations/force/shipping/method": { "put": { "tags": [ "Orders" ], "summary": "Force to change shipping method", "operationId": "orders-operations-force-shipping-method", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "Call center has requested this change" }, "status_id": { "type": "string", "example": "PENDIENTE" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "0" }, "error_message": { "type": "string", "example": "Order error." } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/operations/force/wms/status": { "put": { "tags": [ "Orders" ], "summary": "Force to replace WMS status", "operationId": "orders-operations-force-wms-status", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reason": { "type": "string", "example": "Call center has requested this change" }, "status_id": { "type": "string", "example": "PENDIENTE" } }, "type": "object" } } } }, "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "string", "example": "0" }, "error_message": { "type": "string", "example": "Order status changed successfully." } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{integration_id}/{order_id}": { "get": { "tags": [ "Orders" ], "summary": "Retrieve an order by specifying the external ID", "operationId": "orders-get-by", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "path", "description": "Id of the external integraiton", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/packing-slip": { "get": { "tags": [ "Orders" ], "summary": "Retrieve an order packing slip by specifying the ID", "operationId": "orders-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "properties": { "warehouse_id": { "type": "integer", "example": 1 }, "warehouse_name": { "type": "string", "example": "Warehouse Example" }, "business_id": { "type": "integer", "example": 1 }, "business_name": { "type": "string", "example": "Business Example" }, "order_id": { "type": "integer", "example": 123456 }, "order_external_id": { "type": "string", "example": "EXT-123456" }, "channel_id": { "type": "string", "example": "CHANNEL" }, "shipping_method": { "type": "string", "example": "SHIPPING_METHOD" }, "item_id": { "type": "integer", "example": 1001 }, "item_external_id": { "type": "string", "example": "ITEM-1001", "nullable": true }, "item_title": { "type": "string", "example": "Product Name Example" }, "item_qty": { "type": "string", "example": "1" }, "item_thumb": { "type": "string", "nullable": true }, "item_packing_type": { "type": "string", "example": "item" }, "scan_mode": { "type": "string", "example": "scanned" }, "fulfilled_at": { "type": "string", "format": "date-time", "example": "2026-01-01 12:00:00" }, "packed_by_id": { "type": "integer", "example": 1 }, "packed_by_name": { "type": "string", "example": "User Name" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}": { "get": { "tags": [ "Orders" ], "summary": "Retrieve an order by specifying the ID", "operationId": "orders-get_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/order/{order_id}/invoices/list": { "get": { "tags": [ "Orders" ], "summary": "List all orders invoices", "operationId": "orders-invoices-list-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer" } }, { "name": "limitFrom", "in": "query", "description": "Limit from (pagination), ex: 0", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Limit to (pagination), ex: 10", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/orders/{business_id}/{order_id}/items/decomposed/list": { "get": { "tags": [ "Orders" ], "summary": "Retrieve an order items decomposed list by specifying the ID", "operationId": "orders-items-decomposed-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/{order_id}/items/list": { "get": { "tags": [ "Orders" ], "summary": "Retrieve an order items list by specifying the ID", "operationId": "orders-items-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/operations/cancel/{business_id}/{order_id}": { "put": { "tags": [ "Orders" ], "summary": "Cancel order in any state", "operationId": "orders-operations-cancel", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id number to request", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "stock_type_id", "in": "query", "description": "return stock type id: If null, no stock return. 30 for physical", "required": true, "schema": { "type": "integer" } }, { "name": "stock_warehouse_id", "in": "query", "description": "return stock warehouse id: If null and stock type id is equal 30, stock should return to same warehouse", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/search": { "get": { "tags": [ "Orders" ], "summary": "Find an order by different parameters", "operationId": "orders-search", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "channel", "in": "query", "description": "Channel (Mercadolibre, Shopify, ICBC, etc)", "required": true, "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Buyer last name", "required": true, "schema": { "type": "string" } }, { "name": "identifier", "in": "query", "description": "Order identifier, can be order number, marketplace order id, or shipment id", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/orders/{business_id}/list": { "get": { "tags": [ "Orders" ], "summary": "List orders", "operationId": "orders-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "description": "Filter by Channel ID", "required": false, "schema": { "type": "string" } }, { "name": "shipping_id", "in": "query", "description": "Filter by Shipping ID", "required": false, "schema": { "type": "string" } }, { "name": "depstatus_id", "in": "query", "description": "Filter by Deposit status ID", "required": false, "schema": { "type": "string" } }, { "name": "limitFrom", "in": "query", "description": "Offset for pagination (limitFrom)", "required": false, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Number of records to return (limitTo)", "required": false, "schema": { "type": "integer" } }, { "name": "searchText", "in": "query", "description": "Search text", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/OrdersListOrder" } }, "recordsTotal": { "description": "Total number of records", "type": "integer", "example": 1205601 }, "recordsFiltered": { "description": "Number of records after filtering", "type": "integer", "example": 1205601 } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Outbounds" ], "summary": "Get inbound item by keytype", "operationId": "inbounds-items-find_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/outbounds/order/{order_id}/close": { "get": { "tags": [ "Outbounds" ], "summary": "Close an outbound order", "operationId": "outbounds-order-close-put", "parameters": [ { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}": { "get": { "tags": [ "Outbounds" ], "summary": "Get outbound order details", "operationId": "outbounds-order-detail-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "put": { "tags": [ "Outbounds" ], "summary": "Put a outbound header order to get receive it in a warehouse", "operationId": "outbounds-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/order/{warehouse_id}/dispatch": { "post": { "tags": [ "Outbounds" ], "summary": "Create an outbound order for dispatch packages to a carrier", "operationId": "outbounds-order-dispatch-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID for the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/order/{order_id}": { "get": { "tags": [ "Outbounds" ], "summary": "Get outbound order", "operationId": "outbounds-order-get", "parameters": [ { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/items": { "post": { "tags": [ "Outbounds" ], "summary": "Post items array to an outbound order (bulk)", "operationId": "outbounds-items-post-items", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "outbound_order_id": { "description": "Unique identifier for the outbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/item/{item_id}": { "put": { "tags": [ "Outbounds" ], "summary": "Post item to an outbound order", "operationId": "outbound-items-put-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID target to change quantity", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Item details", "required": true, "content": { "application/json": { "schema": { "properties": { "item_id": { "description": "Unique identifier for the item", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "item_observations": { "description": "Observations about the item (optional)", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "properties": { "outbound_order_id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" }, "item_id": { "description": "Unique identifier for the item", "type": "string" }, "item_title": { "description": "Item title", "type": "string" }, "qty_declared": { "description": "Quantity of the item", "type": "string" }, "id": { "description": "Unique identifier for the response", "type": "integer" } }, "type": "object" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "delete": { "tags": [ "Outbounds" ], "summary": "Delete item in outbound order", "operationId": "outbound-items-delete-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "description": "Array of JSON objects with error = 0", "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/list": { "get": { "tags": [ "Outbounds" ], "summary": "Get outbound items by outbound order id", "operationId": "outbounds-items-list-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/order/{warehouse_id}/list": { "get": { "tags": [ "Outbounds" ], "summary": "List outbound orders by warehouse_id", "operationId": "outbounds-order-list", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/order/{order_id}/dispatch/package": { "post": { "tags": [ "Outbounds" ], "summary": "Post a package into a existing dispatch outbound order", "operationId": "outbounds-order-package-dispatch-post", "parameters": [ { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{relation_type}/{relation_id}/packages/list": { "get": { "tags": [ "Outbounds" ], "summary": "List packages by relation_type and relation_id", "operationId": "outbounds-order-packages-list", "parameters": [ { "name": "relation_type", "in": "path", "description": "Relation type", "required": true, "schema": { "type": "string" } }, { "name": "relation_id", "in": "path", "description": "Relation ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/order/{order_id}/packages": { "get": { "tags": [ "Outbounds" ], "summary": "Get packages from outbound order", "operationId": "outbounds-order-packages-get", "parameters": [ { "name": "order_id", "in": "path", "description": "Outbound order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "description": "Details for the dispatch order", "required": true, "content": { "application/json": { "schema": { "properties": { "service_id": { "description": "Service identifier for the dispatch", "type": "string" }, "vehicle_plate": { "description": "Vehicle plate number", "type": "string" }, "vehicle_photo_base64": { "description": "Base64 encoded photo of the vehicle (optional)", "type": "string" }, "driver_name": { "description": "Name of the driver", "type": "string" }, "driver_license": { "description": "Driver's license number", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order": { "post": { "tags": [ "Outbounds" ], "summary": "Post a inbound header order to get receive it in a warehouse", "operationId": "outbounds-orders_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/shipment": { "put": { "tags": [ "Outbounds" ], "summary": "Put a outbound order hshipment", "operationId": "outbounds-orders-shipment", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Outbound Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/order/{order_id}/status/{status_id}": { "put": { "tags": [ "Outbounds" ], "summary": "Change status of outbound order", "operationId": "outbounds-order-status-put", "parameters": [ { "name": "business_id", "in": "path", "description": "business id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "status (open, close)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{business_id}/orders/list": { "get": { "tags": [ "Outbounds" ], "summary": "List outbounds orders by status", "operationId": "outbounds-list-orders", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID of the order owner", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/outbounds/{warehouse_id}/order/pick/{order_id}/item/{item_id}": { "post": { "tags": [ "Outbounds" ], "summary": "Post picked item", "operationId": "outbound-pick-order-item", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id destination", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "item id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/desk/{desk_id}": { "get": { "tags": [ "Packing" ], "summary": "Get desk by id", "operationId": "packing-desk-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "desk_id", "in": "path", "description": "Desk ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/{order_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Packing" ], "summary": "Get packing item by keytype", "operationId": "packing-items-find", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/packing/{warehouse_id}/packed/{order_id}/item/{item_id}": { "post": { "tags": [ "Packing" ], "summary": "Post packed item", "operationId": "packing-packed-item-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/bin/{bin_id}": { "get": { "tags": [ "Packing" ], "summary": "Get next order id by bin id", "operationId": "packing-order-bin-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "bin_id", "in": "path", "description": "Bin ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/materials/{order_id}": { "get": { "tags": [ "Packing" ], "summary": "Get packing materials by order id", "operationId": "packing-materials-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/picked/{order_id}": { "get": { "tags": [ "Packing" ], "summary": "Get picked by order id", "operationId": "packing-picked-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/{order_id}/print/shipment/label/{desk_id}": { "post": { "tags": [ "Packing" ], "summary": "Send label to printer via internal socket", "operationId": "packing-order-print-shipment-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "desk_id", "in": "path", "description": "destination desk id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/{order_id}/shipments/{identifier_type}/{identifier_id}": { "put": { "tags": [ "Packing" ], "summary": "Put shipment fulfillment status", "operationId": "packing-order-shipments-fulfillment-status-put", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "identifier_type", "in": "path", "description": "Identifier type (tracking)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "identifier_id", "in": "path", "description": "ID of identifier type", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/{order_id}/shipments": { "post": { "tags": [ "Packing" ], "summary": "Post and retrieve shipment labels from courier providers", "operationId": "packing-order-shipments-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/packing/{warehouse_id}/order/{order_id}/status/{status_id}": { "put": { "tags": [ "Packing" ], "summary": "Put order fulfillment status", "operationId": "packing-order-fulfillment-status-put", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "Status id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/payments/{business_id}/order/{order_id}/balance": { "get": { "tags": [ "Payments" ], "summary": "Get order balance and payment methods availables", "operationId": "payments-order-balance-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer" } }, { "name": "limitFrom", "in": "query", "description": "Limit from (pagination), ex: 0", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Limit to (pagination), ex: 10", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/payments/{business_id}/order/{order_id}/transactions": { "get": { "tags": [ "Payments" ], "summary": "Get order transactions", "operationId": "payments-order-transactions-get", "parameters": [ { "name": "business_id", "in": "path", "description": "Business number of item owner", "required": true, "schema": { "type": "integer" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer" } }, { "name": "limitFrom", "in": "query", "description": "Limit from (pagination), ex: 0", "required": true, "schema": { "type": "integer" } }, { "name": "limitTo", "in": "query", "description": "Limit to (pagination), ex: 10", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "" } }, "security": [ { "bearer": [] } ] } }, "/v1/picking/{warehouse_id}/picked/batch/{batch_id}/item/{item_id}": { "post": { "tags": [ "Picking" ], "summary": "Post picked item", "operationId": "picking-picked-item-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "batch_id", "in": "path", "description": "Batch ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "container_totals": { "description": "Total items in container", "type": "integer" }, "container_id": { "description": "Container ID/Barcode", "type": "string" }, "container_expiration": { "description": "Expiration date (YYYY-MM-DD)", "type": "string", "format": "date" }, "mode": { "description": "Mode", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the operation result", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batch/{batch_id}/status/{status_id}": { "put": { "tags": [ "Picking" ], "summary": "Change status of picking batch", "operationId": "picking-batch-status-put", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "batch_id", "in": "path", "description": "batch id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "status (open, close)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches/{batch_id}/items/list": { "get": { "tags": [ "Picking" ], "summary": "Get items list by batch id", "operationId": "picking-batches-items-list", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "batch_id", "in": "path", "description": "Batch ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches/manual": { "post": { "tags": [ "Picking" ], "summary": "Create picking batch by orders_id(s)", "operationId": "picking-batches-manual-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "orders": { "description": "Comma separated orders ids", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickingManualResponse" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches": { "post": { "tags": [ "Picking" ], "summary": "Create picking batch", "operationId": "picking-batches-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches/{batch_id}/bin/{bin_id}": { "post": { "tags": [ "Picking" ], "summary": "Get bin by id", "operationId": "picking-bin-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "batch_id", "in": "path", "description": "Batch ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "bin_id", "in": "path", "description": "Bin ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batch/{order_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Picking" ], "summary": "Get picking item by keytype", "operationId": "picking-items-find", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "business number owner of the orders", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/picking/{warehouse_id}/manual/list": { "get": { "tags": [ "Picking" ], "summary": "List picking manual orders ", "operationId": "picking-manual-list-orders", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/manual/orders/list": { "post": { "tags": [ "Picking" ], "summary": "Retrieve a list of manual picking orders for a specific warehouse.", "description": "This endpoint retrieves a list of manual picking orders based on the provided warehouse ID and other optional filters such as shipping type, shipping tag, and date. Requires a valid API key and user permissions for the specified warehouse.", "operationId": "picking-manual-list-orders_2", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "The unique identifier for the warehouse to fetch manual picking orders from.", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Optional filter for specific orders.", "required": false, "schema": { "type": "string" } } ], "requestBody": { "description": "Payload containing optional filters for the manual picking orders.", "required": true, "content": { "application/json": { "schema": { "properties": { "business_id": { "description": "The business ID associated with the orders.", "type": "integer" }, "shipping_type": { "description": "The type of shipping (e.g., 'express', 'standard').", "type": "string" }, "shipping_tag": { "description": "Tag or label to filter orders by shipping category.", "type": "string" }, "shipping_date": { "description": "Filter orders by the shipping date.", "type": "string", "format": "date" }, "limit": { "description": "The maximum number of orders to retrieve.", "type": "integer" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation.", "content": { "application/json": { "schema": { "properties": { "data": { "description": "List of orders.", "type": "array", "items": { "$ref": "#/components/schemas/Order" } }, "recordsTotal": { "description": "Total number of records available.", "type": "string" }, "recordsFiltered": { "description": "Number of records after applying filters.", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Unauthorized. The user is not authenticated or does not have access to the specified warehouse." }, "403": { "description": "Forbidden. The user does not have permission to access the warehouse." }, "500": { "description": "Internal server error. An unexpected issue occurred." } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/manual/status/{order_id}/{status_id}": { "put": { "tags": [ "Picking" ], "summary": "Put picking order status by order id", "operationId": "picking-manual-status", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "Status ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batch/pending/list": { "get": { "tags": [ "Picking" ], "summary": "List picking pending orders", "operationId": "picking-batches-list-orders", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches/details": { "get": { "tags": [ "Picking" ], "summary": "Get picking pending orders details", "operationId": "picking-batches-details-orders", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } }, { "name": "business_id", "in": "query", "description": "Filter by business ID", "required": false, "schema": { "type": "integer" } }, { "name": "shipping", "in": "query", "description": "Filter by shipping", "required": false, "schema": { "type": "string" } }, { "name": "tag", "in": "query", "description": "Filter by tag", "required": false, "schema": { "type": "string" } }, { "name": "date", "in": "query", "description": "Filter by date", "required": false, "schema": { "type": "string", "format": "date" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/PickingBatchOrderDetail" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/picking/{warehouse_id}/batches/list": { "get": { "tags": [ "Picking" ], "summary": "List picking batches", "operationId": "picking-batches-list", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "integration_id", "in": "query", "description": "Filter by integration ID", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "Filter by topic ID", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/printers/warehouse/{warehouse_id}/devices/list": { "get": { "tags": [ "Printers" ], "summary": "List printers by warehouse_id", "operationId": "printers-devices-list", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/printers/jobs/{printer_id}/{document_id}": { "post": { "tags": [ "Printers" ], "summary": "Post a document job to a specific printer", "operationId": "printers-job-post", "parameters": [ { "name": "printer_id", "in": "path", "description": "Destination printer id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "document_id", "in": "path", "description": "Document id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/putback/{warehouse_id}/item/find/{key_type}/{key_value}": { "get": { "tags": [ "Putback" ], "summary": "Get putback item by keytype", "operationId": "putback-items-find", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "warehouse id", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "key_type", "in": "path", "description": "key type, ex. barcode", "required": true, "schema": { "type": "string" } }, { "name": "key_value", "in": "path", "description": "key value for key type", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "business_id": { "description": "Business ID", "type": "integer" }, "business_name": { "description": "Business fantasy name", "type": "string" }, "item_id": { "description": "Item ID", "type": "integer" }, "item_title": { "description": "Item title", "type": "string" }, "code_multiplier": { "description": "Code multiplier", "type": "integer" }, "code_unit_id": { "description": "Unit code", "type": "string" }, "item_attributes_meta_json": { "description": "Metadata attributes", "type": "object" } }, "type": "object" } } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/putback/{warehouse_id}/item/{item_id}": { "post": { "tags": [ "Putback" ], "summary": "Post putback stock item", "operationId": "putback-stock-item-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "qty": { "description": "Quantity to return to stock", "type": "integer", "example": 1 }, "lot_identifier": { "description": "Lot identifier", "type": "string", "example": "LOTE123" }, "expiration_date": { "description": "Expiration date (YYYY-MM-DD)", "type": "string", "format": "date", "example": "2026-12-31" }, "status": { "description": "Stock status bucket", "type": "string", "example": "accepted", "enum": [ "accepted", "expired", "damaged" ] }, "reason": { "description": "Putback reason", "type": "string", "example": "found_item", "enum": [ "order_cancelled", "packing_cancelled", "dispatch_cancelled", "overweight", "found_item", "other" ] }, "position_id": { "description": "Position ID", "type": "integer", "example": 0 }, "scan_method": { "description": "Scan input method", "type": "string", "example": "barcode", "enum": [ "barcode", "manual" ] }, "comments": { "description": "Comments / Reason", "type": "string", "example": "Returned item" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "message": { "description": "Operation status message", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/putback/{warehouse_id}/order/{order_id}/item/{item_id}": { "post": { "tags": [ "Putback" ], "summary": "Post putback stock order item", "operationId": "putback-stock-order-item-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "qty": { "description": "Quantity to return to stock", "type": "integer", "example": 1 }, "lot_identifier": { "description": "Lot identifier", "type": "string", "example": "LOTE123" }, "expiration_date": { "description": "Expiration date (YYYY-MM-DD)", "type": "string", "format": "date", "example": "2026-12-31" }, "status": { "description": "Stock status bucket", "type": "string", "example": "accepted", "enum": [ "accepted", "expired", "damaged" ] }, "reason": { "description": "Putback reason", "type": "string", "example": "order_cancelled", "enum": [ "order_cancelled", "packing_cancelled", "dispatch_cancelled", "overweight", "found_item", "other" ] }, "position_id": { "description": "Position ID", "type": "integer", "example": 0 }, "scan_method": { "description": "Scan input method", "type": "string", "example": "barcode", "enum": [ "barcode", "manual" ] }, "comments": { "description": "Comments / Reason", "type": "string", "example": "Returned item from order" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "message": { "description": "Operation status message", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/putback/{warehouse_id}/order/{order_id_shipping}/items": { "get": { "tags": [ "Putback" ], "summary": "Get packed items of an order by Order ID or Shipping tracking for Putback", "operationId": "putback-order-items-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id_shipping", "in": "path", "description": "Order ID or Shipping tracking code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "business_id": { "description": "Business ID", "type": "integer" }, "business_name": { "description": "Business fantasy name", "type": "string" }, "order_id": { "description": "Order ID", "type": "integer" }, "item_id": { "description": "Item ID", "type": "integer" }, "title": { "description": "Item title", "type": "string" }, "qty": { "description": "Quantity", "type": "integer" }, "thumb_url": { "description": "Thumbnail URL", "type": "string" } }, "type": "object" } } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "bearer": [] } ] } }, "/v1/putback/{warehouse_id}/orders/list": { "get": { "tags": [ "Putback" ], "summary": "Get list of orders with items restocked through putback flow", "operationId": "putback-orders-list-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "order_id": { "description": "Order ID", "type": "integer" }, "business_id": { "description": "Business ID", "type": "integer" }, "business_name": { "description": "Business fantasy name", "type": "string" }, "warehouse_id": { "description": "Warehouse ID", "type": "integer" }, "putback_status_id": { "description": "Putback status of the order", "type": "string" }, "items_restocked_qty": { "description": "Total quantity of items restocked", "type": "integer" }, "distinct_items_count": { "description": "Count of distinct items restocked", "type": "integer" }, "last_scan_at": { "description": "Timestamp of the last scan", "type": "string", "format": "date-time" } }, "type": "object" } } } } }, "400": { "description": "Warehouse not found or invalid parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Warehouse not found." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/aging/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List items aging", "operationId": "reports-aging-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/expiration/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List items expiration", "operationId": "reports-expiration-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/expiration-sales/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List items expiration and sales", "operationId": "reports-expiration-sales-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "warehouse_id", "in": "query", "description": "Warehouse ID (required, local warehouse)", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "filter_id", "in": "query", "description": "Filter mode: 1 (with Full sales), 2 (local sales only)", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "data": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/inconsistency/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List items inconsistency", "operationId": "reports-inconsistency-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/occupation/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List occupation items", "operationId": "reports-occupation-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/occupation/{business_id}/total": { "get": { "tags": [ "Reports" ], "summary": "Get total occupation use", "operationId": "reports-occupation-total", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/packaging/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List packaging items", "operationId": "reports-packaging-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/reports/stock/{business_id}/list": { "get": { "tags": [ "Reports" ], "summary": "List items stock", "operationId": "reports-stock-list", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/business/{business_id}/inbound": { "post": { "tags": [ "Returns" ], "summary": "Group verified return items for a business into an inbound order ready for putaway storage", "operationId": "returns-inbound-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "warehouse_id": { "description": "Warehouse ID (if not provided in URL)", "type": "integer", "example": 1 }, "business_id": { "description": "Business ID (if not provided in URL)", "type": "integer", "example": 12 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "0 for success, 1 for errors", "type": "integer", "example": 0 }, "id": { "description": "Generated inbound order ID", "type": "integer", "example": 987 }, "message": { "description": "Confirmation message", "type": "string", "example": "Inbound order created for putaway. Business: Tienda Oficial | Items grouped: 15" } }, "type": "object" } } } }, "400": { "description": "Invalid request or no verified items", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "No verified items found for this business." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/order/{order_id}/item/{item_id}": { "post": { "tags": [ "Returns" ], "summary": "Verify and log a returned item at inspection station and assign intermediate bin/cart", "operationId": "returns-order-item-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "qty": { "description": "Quantity returned", "type": "integer", "example": 1 }, "bin_id": { "description": "Intermediate bin/cart code", "type": "string", "example": "CART-01" }, "status": { "description": "Item condition status", "type": "string", "example": "accepted", "enum": [ "accepted", "damaged", "expired" ] }, "lot_identifier": { "description": "Lot identifier", "type": "string", "example": "LOTE-9988" }, "expiration_date": { "description": "Expiration date (YYYY-MM-DD), required if status is expired", "type": "string", "format": "date", "example": "2027-01-15" }, "scan_method": { "description": "Scan input method", "type": "string", "example": "barcode", "enum": [ "barcode", "manual" ] }, "comments": { "description": "Additional notes or comments", "type": "string", "example": "Packaging opened but intact" }, "order_id": { "description": "Order ID (if not provided in URL)", "type": "integer", "example": 78910 }, "item_id": { "description": "Item ID (if not provided in URL)", "type": "integer", "example": 5541 }, "warehouse_id": { "description": "Warehouse ID (if not provided in URL)", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "0 for success, 1 for errors", "type": "integer", "example": 0 }, "message": { "description": "Result description message", "type": "string", "example": "Item verified and queued for putaway. Order ID: 78910 | Item ID: 5541 | Qty: 1 | Bin: CART-01" } }, "type": "object" } } } }, "400": { "description": "Validation error", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Bin is required." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/tracking/{tracking}/items": { "get": { "tags": [ "Returns" ], "summary": "Get expected items for a returned package by scanned tracking", "operationId": "returns-order-items-by-shipping-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "tracking", "in": "path", "description": "Scanned package tracking number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "business_id": { "description": "Business ID owning the item", "type": "integer", "example": 12 }, "business_name": { "description": "Business fantasy name", "type": "string", "example": "Tienda Oficial" }, "order_id": { "description": "Associated Order ID", "type": "integer", "example": 78910 }, "item_id": { "description": "Expected Item ID", "type": "integer", "example": 5541 }, "title": { "description": "Item title / description", "type": "string", "example": "Remera Algodon Talle L" }, "qty": { "description": "Expected return quantity", "type": "integer", "example": 2 }, "item_attributes_meta_json": { "description": "Additional item metadata attributes", "type": "object" } }, "type": "object" } } } } }, "400": { "description": "Invalid request or package not found", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Package not found for this warehouse." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/receipt/{receipt_id}/package": { "post": { "tags": [ "Returns" ], "summary": "Scan and receive a physical package in a return receipt", "operationId": "returns-package-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "receipt_id", "in": "path", "description": "Putback Receipt ID", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "tracking": { "description": "Scanned package tracking number", "type": "string", "example": "4000123456789" }, "package_status": { "description": "Package condition status", "type": "string", "example": "accepted", "enum": [ "accepted", "accepted_damaged", "rejected", "rejected_damaged" ] }, "receipt_id": { "description": "Putback Receipt ID (if not provided in URL)", "type": "integer", "example": 123 }, "warehouse_id": { "description": "Warehouse ID (if not provided in URL)", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code (0 for success, 1 for errors)", "type": "integer", "example": 0 }, "id": { "description": "Package ID", "type": "integer", "example": 456 }, "business_id": { "description": "Business ID of identified order", "type": "integer", "example": 12 }, "business_name": { "description": "Business fantasy name", "type": "string", "example": "Tienda Oficial" }, "order_id": { "description": "Identified Order ID", "type": "integer", "example": 78910 }, "shipping": { "description": "Shipping method of the order", "type": "string", "example": "ME-FLEX" }, "message": { "description": "Status message", "type": "string", "example": "Package received successfully." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/receipt/{receipt_id}/package/{package_id}": { "delete": { "tags": [ "Returns" ], "summary": "Delete a scanned return package from intake receipt", "operationId": "returns-package-delete", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "receipt_id", "in": "path", "description": "Putback Receipt ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "package_id", "in": "path", "description": "Package ID or tracking number", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code (0 for success, 1 for errors)", "type": "integer", "example": 0 }, "id": { "description": "Package ID", "type": "integer", "example": 6 }, "receipt_id": { "description": "Receipt ID", "type": "integer", "example": 10 }, "warehouse_id": { "description": "Warehouse ID", "type": "integer", "example": 5 }, "message": { "description": "Status message", "type": "string", "example": "Package deleted successfully." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/packages/list": { "get": { "tags": [ "Returns" ], "summary": "Get list of packages registered in returns intake", "operationId": "returns-packages-list-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "description": "Package ID", "type": "integer" }, "putback_receipt_id": { "description": "Putback receipt ID", "type": "integer", "nullable": true }, "receipt_status": { "description": "Status of the intake receipt", "type": "string", "nullable": true }, "driver_name": { "description": "Name of the delivery driver", "type": "string", "nullable": true }, "vehicle_plate": { "description": "Vehicle license plate", "type": "string", "nullable": true }, "package_source": { "description": "Resolved origin of the package", "type": "string", "enum": [ "own_dispatch", "meli_return", "meli_full", "unrecognized" ] }, "tracking": { "description": "Scanned tracking number", "type": "string" }, "carrier_id": { "description": "Carrier ID", "type": "integer", "nullable": true }, "carrier_name": { "description": "Carrier name", "type": "string", "nullable": true }, "business_id": { "description": "Business ID", "type": "integer", "nullable": true }, "business_name": { "description": "Business fantasy name", "type": "string", "nullable": true }, "order_id": { "description": "Associated Order ID", "type": "integer", "nullable": true }, "package_number": { "description": "Package sequence number in order", "type": "integer", "nullable": true }, "package_status": { "description": "Package condition status at scan", "type": "string", "nullable": true }, "created_by": { "description": "User ID of operator", "type": "integer", "nullable": true }, "created_by_username": { "description": "Username of operator", "type": "string", "nullable": true }, "created_at": { "description": "Scan timestamp", "type": "string", "format": "date-time" }, "return_id": { "description": "Associated Return ID", "type": "integer", "nullable": true }, "return_number": { "description": "Associated Return human-readable number", "type": "string", "nullable": true }, "return_status": { "description": "Associated Return lifecycle status", "type": "string", "nullable": true } }, "type": "object" } } } } }, "400": { "description": "Warehouse not found or invalid parameters", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Warehouse ID is required and must be greater than zero." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/receipt": { "post": { "tags": [ "Returns" ], "summary": "Create return receipt intake header", "operationId": "returns-receipt-post", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": false, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "warehouse_id": { "description": "Warehouse ID (if not provided in URL)", "type": "integer", "example": 1 }, "carrier_id": { "description": "Carrier ID (from shipments_carriers)", "type": "integer", "example": 3 }, "vehicle_plate": { "description": "Vehicle plate", "type": "string", "example": "AA123BB" }, "driver_name": { "description": "Driver name", "type": "string", "example": "Juan Perez" }, "driver_license": { "description": "Driver license", "type": "string", "example": "12345678" }, "comments": { "description": "Additional comments", "type": "string", "example": "Devolución ruta norte" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code (0 for success, 1 for errors)", "type": "integer", "example": 0 }, "id": { "description": "Created receipt ID", "type": "integer", "example": 123 }, "message": { "description": "Status message", "type": "string", "example": "Receipt created for carrier PROCOURRIER." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/receipt/{receipt_id}/status/{status_id}": { "put": { "tags": [ "Returns" ], "summary": "Update return receipt status", "operationId": "returns-receipt-status-put", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": false, "schema": { "type": "integer", "format": "int32" } }, { "name": "receipt_id", "in": "path", "description": "Returns Receipt ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "New status: receiving, received, processing, processed, storing, stored, or cancelled", "required": false, "schema": { "type": "string", "enum": [ "receiving", "received", "processing", "processed", "storing", "stored", "cancelled" ] } } ], "requestBody": { "required": false, "content": { "application/json": { "schema": { "properties": { "status": { "description": "New status", "type": "string", "example": "received", "enum": [ "receiving", "received", "processing", "processed", "storing", "stored", "cancelled" ] }, "warehouse_id": { "description": "Warehouse ID (if not provided in URL)", "type": "integer", "example": 1 } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code (0 for success, 1 for errors)", "type": "integer", "example": 0 }, "message": { "description": "Operation status message", "type": "string", "example": "Receipt status updated" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/list": { "get": { "tags": [ "Returns" ], "summary": "Get paginated list of physical returns (RMA)", "operationId": "returns-list-get", "parameters": [ { "name": "status", "in": "query", "description": "Status filter or preset (active, pending_receipt, received_all, received_issues, all, or specific status)", "required": false, "schema": { "type": "string", "enum": [ "active", "pending_receipt", "received_all", "received_issues", "pending", "received_unidentified", "received", "in_review", "reviewed", "resolved", "cancelled", "all" ] } }, { "name": "type", "in": "query", "description": "Return type", "required": false, "schema": { "type": "string", "enum": [ "all", "return", "undelivered_return", "transit_incident", "exchange" ] } }, { "name": "origin", "in": "query", "description": "Return channel / origin", "required": false, "schema": { "type": "string", "enum": [ "all", "marketplace_claim", "carrier_rejected", "internal_manual", "customer_portal" ] } }, { "name": "searchText", "in": "query", "description": "Search text across return number, order ID, tracking, ID Meli", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "recordsTotal": { "type": "integer", "example": 60 }, "recordsFiltered": { "type": "integer", "example": 60 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 66 }, "return_number": { "type": "string", "example": "RET-CLM-5259972323" }, "order_id": { "type": "integer", "example": 14490123 }, "integration_origin_id": { "type": "string", "example": "2000012345678901" }, "status": { "type": "string", "example": "in_review", "enum": [ "pending", "received_unidentified", "received", "in_review", "reviewed", "resolved", "cancelled" ] }, "integration_shipping_status": { "type": "string", "example": "in_transit", "nullable": true, "enum": [ "requested", "in_transit", "delivered", "not_delivered", "cancelled", "expired" ] }, "type": { "type": "string", "example": "return" }, "origin": { "type": "string", "example": "marketplace_claim" }, "shipment_tracking": { "type": "string", "example": "47371591631" }, "shipment_carrier_tracking": { "type": "string", "example": "45188110700" }, "shipment_date_received": { "type": "string", "format": "date-time", "nullable": true }, "shipment_date_delivered": { "type": "string", "format": "date-time", "nullable": true }, "returns_package_id": { "type": "integer", "example": 123, "nullable": true }, "refund_amount": { "type": "number", "format": "float", "example": 12500.5 }, "created_at": { "type": "string", "format": "date-time", "example": "2026-10-07 15:30:00" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/summary": { "get": { "tags": [ "Returns" ], "summary": "Get returns summary KPI counts across return statuses", "operationId": "returns-summary-get", "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "pending": { "type": "integer", "example": 12 }, "received_unidentified": { "type": "integer", "example": 2 }, "received": { "type": "integer", "example": 8 }, "in_review": { "type": "integer", "example": 5 }, "reviewed": { "type": "integer", "example": 3 }, "resolved": { "type": "integer", "example": 27 }, "cancelled": { "type": "integer", "example": 1 }, "transit_incident": { "type": "integer", "example": 2 }, "total": { "type": "integer", "example": 60 } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{return_id}": { "get": { "tags": [ "Returns" ], "summary": "Get detailed return record including items, review sources, and package", "operationId": "returns-detail-get", "parameters": [ { "name": "return_id", "in": "path", "description": "Return record ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "return": { "properties": { "id": { "type": "integer", "example": 66 }, "business_id": { "type": "integer", "example": 12, "nullable": true }, "order_id": { "type": "integer", "example": 14490123, "nullable": true }, "return_number": { "type": "string", "example": "RET-CLM-5259972323" }, "external_claim_id": { "type": "string", "example": "5259972323" }, "integration_origin_id": { "type": "string", "example": "2000012345678901" }, "status": { "type": "string", "example": "in_review", "enum": [ "pending", "received_unidentified", "received", "in_review", "reviewed", "resolved", "cancelled" ] }, "integration_shipping_status": { "type": "string", "example": "in_transit", "nullable": true, "enum": [ "requested", "in_transit", "delivered", "not_delivered", "cancelled", "expired" ] }, "type": { "type": "string", "example": "return" }, "origin": { "type": "string", "example": "marketplace_claim" }, "refund_amount": { "type": "number", "format": "float", "example": 12500.5 }, "tracking": { "type": "string", "example": "47371591631", "nullable": true }, "carrier_tracking": { "type": "string", "example": "45188110700", "nullable": true }, "tracking_url": { "type": "string", "nullable": true }, "returns_package_id": { "type": "integer", "example": 123, "nullable": true }, "date_received": { "type": "string", "format": "date-time", "nullable": true }, "date_delivered": { "type": "string", "format": "date-time", "nullable": true }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "items": { "type": "array", "items": { "type": "object" } }, "review": { "properties": { "meli": { "type": "array", "items": { "type": "object" } }, "order": { "type": "array", "items": { "type": "object" } }, "packing": { "type": "array", "items": { "type": "object" } }, "returned": { "type": "array", "items": { "type": "object" } } }, "type": "object" }, "package": { "type": "object", "nullable": true }, "exchange": { "type": "object", "nullable": true } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] }, "put": { "tags": [ "Returns" ], "summary": "Update return metadata (reason description)", "operationId": "returns-detail-put", "parameters": [ { "name": "return_id", "in": "path", "description": "Return record ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "reason_description": { "description": "Updated reason description", "type": "string" }, "reason_category": { "description": "Updated reason category", "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "message": { "type": "string", "example": "Return updated successfully." }, "id": { "type": "integer", "example": 66 } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{return_id}/status": { "put": { "tags": [ "Returns" ], "summary": "Manual closing status transition for a return (resolved or cancelled)", "operationId": "returns-status-put", "parameters": [ { "name": "return_id", "in": "path", "description": "Return ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "status": { "description": "New closing status", "type": "string", "enum": [ "resolved", "cancelled" ] } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "status": { "type": "string", "example": "resolved" }, "claims_pending": { "type": "integer", "example": 0 }, "message": { "type": "string", "example": "Status updated successfully." } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{return_id}/item/{item_id}/restock-qty": { "put": { "tags": [ "Returns" ], "summary": "Set CX restock decision by quantity for an item/lot/expiration group in a return", "operationId": "returns-item-restock-qty-put", "parameters": [ { "name": "return_id", "in": "path", "description": "Return ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "item_id", "in": "path", "description": "Item ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "qty_approved": { "description": "Quantity approved for restock (>= 0)", "type": "integer", "example": 5 }, "lot_identifier": { "description": "Optional lot identifier", "type": "string", "example": "L-2024-001", "nullable": true }, "expiration_date": { "description": "Optional expiration date (YYYY-MM-DD)", "type": "string", "format": "date", "example": "2026-12-31", "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "units_approved": { "type": "integer", "example": 5 }, "units_rejected": { "type": "integer", "example": 2 }, "units_locked": { "type": "integer", "example": 0 }, "message": { "type": "string", "example": "Restock quantity updated." } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/returns/{warehouse_id}/inbound-pending": { "get": { "tags": [ "Returns" ], "summary": "List items approved by CX for restock pending inbound creation, grouped by business", "operationId": "returns-inbound-pending-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "data": { "type": "array", "items": { "properties": { "business_id": { "type": "integer", "example": 12 }, "business_name": { "type": "string", "example": "Tienda Oficial" }, "items_count": { "type": "integer", "example": 3 }, "qty_total": { "type": "integer", "example": 7 }, "returns": { "type": "array", "items": { "type": "string" } }, "items": { "type": "array", "items": { "type": "object" } } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/claims-payments/list": { "get": { "tags": [ "Returns" ], "summary": "Get paginated list of claims payments", "operationId": "claims-payments-list-get", "parameters": [ { "name": "business_id", "in": "query", "description": "Business ID", "required": false, "schema": { "type": "integer" } }, { "name": "status", "in": "query", "description": "Claim payment status (pending_decision, accepted, rejected, cancelled)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "return_id": { "type": "integer", "example": 66 }, "business_id": { "type": "integer", "example": 12 }, "status": { "type": "string", "example": "pending_decision" }, "claim_amount": { "type": "number", "format": "float", "example": 15000 }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/claims-payments": { "post": { "tags": [ "Returns" ], "summary": "Create a claim payment record for a return", "operationId": "claims-payments-post", "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "return_id": { "description": "Return ID", "type": "integer", "example": 66 }, "claim_amount": { "type": "number", "format": "float", "example": 15000 }, "claim_reason": { "type": "string", "example": "Missing items" }, "carrier_id": { "type": "integer", "example": 3, "nullable": true } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "id": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "Claim payment registered." } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/claims-payments/{claim_payment_id}": { "put": { "tags": [ "Returns" ], "summary": "Update claim payment status and resolution", "operationId": "claims-payments-put", "parameters": [ { "name": "claim_payment_id", "in": "path", "description": "Claim Payment ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "status": { "type": "string", "enum": [ "pending_decision", "accepted", "rejected", "cancelled" ] }, "resolution_notes": { "type": "string" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "message": { "type": "string", "example": "Claim payment updated." } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/claims-payments/{claim_payment_id}/events": { "get": { "tags": [ "Returns" ], "summary": "Get timeline events of a claim payment", "operationId": "claims-payments-events-get", "parameters": [ { "name": "claim_payment_id", "in": "path", "description": "Claim Payment ID", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "events": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 1 }, "event_type": { "type": "string", "example": "status_changed" }, "notes": { "type": "string", "example": "Claim accepted by carrier" }, "created_at": { "type": "string", "format": "date-time" } }, "type": "object" } } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] }, "post": { "tags": [ "Returns" ], "summary": "Add timeline event to a claim payment", "operationId": "claims-payments-events-post", "parameters": [ { "name": "claim_payment_id", "in": "path", "description": "Claim Payment ID", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "properties": { "event_type": { "type": "string", "example": "note_added" }, "notes": { "type": "string", "example": "Requested documentation from carrier" } }, "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "message": { "type": "string", "example": "Event recorded." } }, "type": "object" } } } } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/rates/{tenant_id}/{integration_id}/{credential_id}": { "post": { "tags": [ "Shipments" ], "summary": "Get shipment rates by items (Integrated)", "description": "Returns shipment rates for a list of items. Supports integration-specific formats (e.g., Shopify CarrierService). This endpoint is used by external integrations to calculate shipping costs during checkout.", "operationId": "shipments-rates-by-items", "parameters": [ { "name": "tenant_id", "in": "path", "description": "Tenant ID owner of the order", "required": true, "schema": { "type": "string" } }, { "name": "integration_id", "in": "path", "description": "Integration ID (e.g., 81 for Shopify)", "required": true, "schema": { "type": "integer" } }, { "name": "credential_id", "in": "path", "description": "Credential ID for the integration", "required": true, "schema": { "type": "integer" } } ], "requestBody": { "description": "Shopify CarrierService Request Payload", "required": true, "content": { "application/json": { "schema": { "type": "object" } } } }, "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": {} } } }, "400": { "description": "Invalid input or missing required fields" } } } }, "/v1/shipments/rates/{business_id}/cart/all": { "get": { "tags": [ "Shipments" ], "summary": "Get all shipments options and costs for use in frontend carts", "operationId": "shipments-rates-shopify", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server error" } } } }, "/v1/shipments/rates/{business_id}/cart/resume": { "get": { "tags": [ "Shipments" ], "summary": "Get the best shipment option by ip location calculated on the fly", "operationId": "shipments-rates-shopify_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server error" } } } }, "/v1/shipments/rates/{business_id}/shopify/": { "post": { "tags": [ "Shipments" ], "summary": "Get shipment rates to select in Shopify checkout frontend", "description": "Its fullfill request from Shopify as descripted in: https://shopify.dev/api/admin/rest/reference/shipping-and-fulfillment/carrierservice", "operationId": "shipments-rates-shopify_3", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server error" } } } }, "/v1/shipments/rates/{business_id}": { "get": { "tags": [ "Shipments" ], "summary": "Get shipment rates by zip code", "operationId": "shipments-rates-shopify_4", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server error" } } } }, "/v1/shipments/{business_id}/{order_id}": { "get": { "tags": [ "Shipments" ], "summary": "Get shipments by order id", "operationId": "shipments-by-order", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "order id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "500": { "description": "Server error" } } } }, "/v1/shipments/carriers/list": { "get": { "tags": [ "Shipments" ], "summary": "List shipment carriers (shipments_carriers)", "operationId": "shipments-carriers-list-get", "parameters": [ { "name": "active", "in": "query", "description": "Filter by active status (1 for active, 0 for inactive, all for all)", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "Search by carrier name or fiscal name", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "total": { "type": "integer", "example": 9 }, "data": { "type": "array", "items": { "properties": { "id": { "type": "integer", "example": 3 }, "name": { "type": "string", "example": "ANDREANI" }, "fiscal_name": { "type": "string", "example": "ANDREANI LOGISTICA S.A.", "nullable": true }, "fiscal_id": { "type": "string", "example": "30-52714245-1", "nullable": true }, "fiscal_condition": { "type": "string", "example": "RESPONSABLE INSCRIPTO", "nullable": true }, "cross_addr": { "type": "string", "nullable": true }, "cross_zip": { "type": "string", "nullable": true }, "cross_city": { "type": "string", "nullable": true }, "cross_province": { "type": "string", "nullable": true }, "cross_country": { "type": "string", "example": "AR" }, "cross_comments": { "type": "string", "nullable": true }, "active": { "type": "integer", "example": 1 }, "created_at": { "type": "string", "example": "2026-04-24 16:57:09" }, "updated_at": { "type": "string", "nullable": true } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/map": { "get": { "tags": [ "Shipments" ], "summary": "Get GPS geolocated shipments for transit map", "operationId": "shipments-map-get", "parameters": [ { "name": "business_id", "in": "query", "description": "business id", "required": false, "schema": { "type": "integer" } }, { "name": "interval", "in": "query", "description": "date range interval (e.g. 01/08/2026 - 23/08/2026)", "required": false, "schema": { "type": "string" } }, { "name": "filter_id", "in": "query", "description": "operational status/incident filter", "required": false, "schema": { "type": "string" } }, { "name": "service_id", "in": "query", "description": "carrier service id", "required": false, "schema": { "type": "integer" } }, { "name": "channel_id", "in": "query", "description": "sales channel id", "required": false, "schema": { "type": "string" } }, { "name": "search", "in": "query", "description": "search keyword", "required": false, "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "maximum number of GPS points", "required": false, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/packages/{package_id}/detail": { "get": { "tags": [ "Shipments" ], "summary": "Get shipment details and timeline trace by package id", "operationId": "shipments-package-detail-get", "parameters": [ { "name": "package_id", "in": "path", "description": "package / shipment id", "required": true, "schema": { "type": "integer" } } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/packages/list": { "get": { "tags": [ "Shipments" ], "summary": "Get server-side paginated list of packages in transit", "operationId": "shipments-packages-list-get", "parameters": [ { "name": "page", "in": "query", "description": "page number", "required": false, "schema": { "type": "integer" } }, { "name": "limit", "in": "query", "description": "items per page", "required": false, "schema": { "type": "integer" } }, { "name": "order_by", "in": "query", "description": "sort column (order_id, created_at, tracking, status_carrier, shipped_at)", "required": false, "schema": { "type": "string" } }, { "name": "order_dir", "in": "query", "description": "sort direction (asc, desc)", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation" } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/{business_id}/{order_id}/tracking": { "get": { "tags": [ "Shipments" ], "summary": "Get package tracking timeline for all shipments of an order (backoffice full detail)", "operationId": "shipments-tracking-by-order", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "order_id", "in": "path", "description": "Order ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation. Each package includes `status_id` (registered|collected|in_transit|last_mile|delivered|cancelled or a delivery incident: rescheduled|nobody_home|not_delivered|wrong_address|rejected|returned), an `incident` object (type, label, severity warning|danger, date, source carrier|thirdparty|timestamp, raw_status; null when none) and a `timeline` that, when an incident exists, contains an extra `incident` step between `last_mile` and `delivered`. Root also exposes `incidents_total` (packages whose current status is an incident).", "content": { "application/json": { "schema": { "type": "object" } } } }, "404": { "description": "Order not found" }, "500": { "description": "Server error" } } } }, "/v1/stats/summary/sales/{business_id}/resume": { "get": { "tags": [ "Stats" ], "summary": "Get sales summary between date range", "operationId": "stats-summary-sales-resume", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateFrom", "in": "query", "description": "Extra customizable params", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "Extra customizable params", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/stats/summary/sales/{business_id}/items": { "get": { "tags": [ "Stats" ], "summary": "Get sales summary items between date range", "operationId": "stats-summary-sales-items", "parameters": [ { "name": "business_id", "in": "path", "description": "Business ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "dateFrom", "in": "query", "description": "Extra customizable params", "required": false, "schema": { "type": "string" } }, { "name": "dateTo", "in": "query", "description": "Extra customizable params", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/stats/summary/sales": { "get": { "tags": [ "Stats" ], "summary": "Get sales summary for all businesses and channels by user access", "operationId": "stats-summary-sales", "parameters": [ { "name": "params", "in": "query", "description": "Extra customizable params", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/templates/{business_id}/{template_id}": { "get": { "tags": [ "Templates" ], "summary": "Get template by id", "operationId": "template-get", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "template_id", "in": "path", "description": "template id", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/templates/{business_id}": { "get": { "tags": [ "Templates" ], "summary": "List all available templates", "operationId": "templates-list", "parameters": [ { "name": "business_id", "in": "path", "description": "business number", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "type", "in": "query", "description": "Template type id", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/tracking/{tracking_id}": { "get": { "tags": [ "Tracking" ], "summary": "Get complete tracking data by tracking id", "description": "Returns complete tracking data for a specific order using its encoded tracking hash.", "operationId": "tracking-get-by-tracking-id", "parameters": [ { "name": "tracking_id", "in": "path", "description": "Encoded tracking ID hash", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Invalid input or missing required fields" } } } }, "/v1/tracking/mercadolibre/{shipment_id}": { "get": { "tags": [ "Tracking" ], "summary": "Get shipment status by MercadoLibre shipment_id", "operationId": "tracking-get", "parameters": [ { "name": "shipment_id", "in": "path", "description": "Shipment ID", "required": true, "schema": { "type": "integer", "format": "int64" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/Shipment" } } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } } } }, "/v1/users/session/logout": { "get": { "tags": [ "Users" ], "summary": "Close session and logout", "operationId": "users-get-logout", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/users/me": { "get": { "tags": [ "Users" ], "summary": "Get my user data", "operationId": "users-get-my-config", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/users/{business_id}/config/me": { "get": { "tags": [ "Users" ], "summary": "Get my config params", "operationId": "users-get-my-config_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] }, "put": { "tags": [ "Users" ], "summary": "Modify my user config", "operationId": "users-get-my-config_3", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/users/session/firebase/login": { "get": { "tags": [ "Users" ], "summary": "Get session via firebase google identity", "operationId": "users-get-firebase-login", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/users/totp/validator/{code}": { "get": { "tags": [ "Users" ], "summary": "Validate TOTP code", "operationId": "users-post-totp-validator", "parameters": [ { "name": "code", "in": "path", "description": "TOTP Code", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/users/{business_id}/devices/{device_id}": { "put": { "tags": [ "Users" ], "summary": "Post or put device id data for notifications", "operationId": "users-put-device_2", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "device_id", "in": "path", "description": "Device ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/warehouses/{warehouse_id}/bins/{bin_id}": { "get": { "tags": [ "Warehouses" ], "summary": "Get and validate a warehouse bin by ID", "operationId": "warehouses-bins-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "bin_id", "in": "path", "description": "Bin identifier / barcode", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Bin found and active", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 0 }, "id": { "type": "string", "example": "EF1-B-001" }, "warehouse_id": { "type": "integer", "example": 1 } }, "type": "object" } } } }, "400": { "description": "Bin not found or invalid", "content": { "application/json": { "schema": { "properties": { "error": { "type": "integer", "example": 1 }, "message": { "type": "string", "example": "El BIN especificado no existe." } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/warehouses/{warehouse_id}/config/list": { "get": { "tags": [ "Warehouses" ], "summary": "Get warehouse config", "operationId": "warehouses-config-get", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "type": "array", "items": { "properties": { "id": { "description": "Unique identifier for the config entry", "type": "integer" }, "warehouse_id": { "description": "Warehouse ID", "type": "integer" }, "folder_id": { "description": "Folder identifier", "type": "string" }, "key": { "description": "Config key", "type": "string" }, "value": { "description": "Config value", "type": "string" }, "relation_type": { "description": "Type of relation, if any", "type": "string" }, "relation_id": { "description": "ID of the related entity", "type": "string" }, "created_at": { "description": "Creation timestamp", "type": "string", "format": "date-time" }, "updated_at": { "description": "Last update timestamp", "type": "string", "format": "date-time", "nullable": true } }, "type": "object" } } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code", "type": "integer" }, "message": { "description": "Error message", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/warehouses/{warehouse_id}/positions/labels": { "get": { "tags": [ "Warehouses" ], "summary": "Get position labels data", "operationId": "warehouses-positions-labels", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/warehouses/{warehouse_id}/positions/list": { "get": { "tags": [ "Warehouses" ], "summary": "List warehouse positions", "operationId": "warehouses-positions-list", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/warehouses/{warehouse_id}/positions/options": { "get": { "tags": [ "Warehouses" ], "summary": "List warehouse positions options", "operationId": "warehouses-positions-options", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "error": { "description": "Error code, 0 for success, non-zero for errors", "type": "integer" }, "id": { "description": "Unique identifier for the dispatch order", "type": "integer" } }, "type": "object" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "properties": { "fieldErrors": { "type": "array", "items": { "properties": { "name": { "description": "Name of the field with error", "type": "string" }, "status": { "description": "Error status message", "type": "string" } }, "type": "object" } } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/websockets/{business_id}/client_auth": { "post": { "tags": [ "Websockets" ], "summary": "Request auth token to send messages from client to websocket server", "operationId": "websocket-client-auth", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/websockets/{business_id}/messages/{channel_id}/{event_id}": { "post": { "tags": [ "Websockets" ], "summary": "Post new message into real time broadcast", "operationId": "websockets-message-post", "parameters": [ { "name": "business_id", "in": "path", "description": "business number owner of the order", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "channel_id", "in": "path", "description": "Specify channel_id destination", "required": true, "schema": { "type": "string" } }, { "name": "event_id", "in": "path", "description": "Event ID", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { "type": "string" } } } }, "401": { "description": "Invalid api key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } }, "/v1/shipments/packages/{warehouse_id}/{status_id}": { "get": { "tags": [ "Wms" ], "summary": "Get carrier services packages qty by status_id and warehouse_id", "operationId": "wms-orders-carriers-by-status", "parameters": [ { "name": "warehouse_id", "in": "path", "description": "Warehouse ID", "required": true, "schema": { "type": "integer", "format": "int32" } }, { "name": "status_id", "in": "path", "description": "Status ID (pending, packed, shipped, delivered, cancelled)", "required": true, "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "Successful operation", "content": { "application/json": { "schema": { "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/Thread" } }, "recordsTotal": { "description": "Total number of records", "type": "string" }, "recordsFiltered": { "description": "Number of records after filtering", "type": "string" } }, "type": "object" } } } }, "401": { "description": "Invalid API key supplied" }, "500": { "description": "Server error" } }, "security": [ { "apiKey": [] } ] } } }, "components": { "schemas": { "Inbound": { "title": "Inbound Object", "description": "Details of an inbound order", "properties": { "id": { "description": "Unique identifier for the inbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" } }, "type": "object" }, "Inbounds": { "title": "Inbound Object", "description": "Details of a inbound order", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" } }, "type": "object" }, "Item": { "title": "Item object", "description": "Item details", "properties": { "id": { "description": "Unique identifier for the item", "type": "string" }, "business_id": { "description": "Business ID of the buyer owner", "type": "string" }, "name": { "description": "Buyer name", "type": "string" }, "document_type": { "description": "Document type", "type": "string" }, "created_at": { "description": "Timestamp of item creation", "type": "string", "format": "date-time" }, "updated_at": { "description": "Timestamp of item last update", "type": "string", "format": "date-time" } }, "type": "object" }, "Log": { "title": "Log Object", "description": "Details of a log", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" } }, "type": "object" }, "Message": { "title": "Message Object", "description": "Details of a message", "properties": { "id": { "type": "string" }, "thread_id": { "type": "string" }, "external_id": { "type": "string" }, "direction": { "type": "string" }, "content": { "description": "HTML content of the message", "type": "string" }, "created_by": { "description": "User who created the message", "type": "string" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } }, "type": "object" }, "Order": { "title": "Order Object", "description": "Details of a manual picking order.", "properties": { "id": { "description": "Unique identifier for the order.", "type": "integer" }, "business_id": { "description": "Business ID associated with the order.", "type": "integer" }, "shipping_type": { "description": "Type of shipping for the order.", "type": "string" }, "shipping_tag": { "description": "Tag or label associated with the shipping.", "type": "string" }, "shipping_date": { "description": "Date the order is scheduled for shipping.", "type": "string", "format": "date" }, "warehouse_id": { "description": "Warehouse ID where the order is managed.", "type": "integer" } }, "type": "object" }, "OrdersListOrder": { "title": "Orders List Order", "description": "Details of an order in the list", "properties": { "id": { "type": "integer", "example": 14330791 }, "business_id": { "type": "integer", "example": 3 }, "business_warehouse_id": { "type": "integer", "example": 6 }, "warehouse_id": { "type": "integer", "example": 2 }, "channel_id": { "type": "string", "example": "MERCADOLIBRE" }, "channel_sub_id": { "type": "string", "example": "Meli-Full-Store" }, "type_id": { "type": "string", "example": "purchase" }, "authorization_status_id": { "type": "string", "example": "authorized" }, "payment_status_id": { "type": "string", "example": "paid", "nullable": true }, "fulfillment_status_id": { "type": "string", "example": "pending" }, "cancel_status_id": { "type": "string", "nullable": true }, "delivery_status_id": { "type": "string", "nullable": true }, "buyer_name": { "type": "string", "example": "JOHN DOE" }, "buyer_mail": { "type": "string", "example": "john.doe@example.com", "nullable": true }, "buyer_phone": { "type": "string", "example": "+541199998888", "nullable": true }, "buyer_external_id": { "type": "string", "example": "53348176" }, "total_items_after_taxs": { "type": "string", "example": "3395.32" }, "total_buyer_charged": { "type": "string", "example": "3395.32" }, "total_after_taxs": { "type": "string", "example": "3395.32" }, "total": { "type": "string", "example": "3395.32" }, "total_due": { "type": "string", "example": "0.00" }, "PAYMETHOD": { "type": "string", "example": "MERCADOPAGO" }, "DEPSTATUS": { "type": "string", "example": "PENDIENTE" }, "SALSTATUS": { "type": "string", "example": "PENDIENTE" }, "SHIPPING": { "type": "string", "example": "ME-FULL" }, "shipping_cost": { "type": "string", "example": "500.00", "nullable": true }, "shipping_date_fulfillment_limit": { "type": "string", "format": "date-time", "example": "2026-04-21 16:30:00", "nullable": true }, "shipping_date_delivery_limit": { "type": "string", "format": "date-time", "example": "2026-04-21 21:00:00", "nullable": true }, "shipping_addr_street": { "type": "string", "example": "Main Street" }, "shipping_addr_street_number": { "type": "string", "example": "123" }, "shipping_addr_city": { "type": "string", "example": "Springfield" }, "shipping_addr_province": { "type": "string", "example": "Buenos Aires" }, "shipping_addr_zip": { "type": "string", "example": "1234" }, "shipping_addr_country": { "type": "string", "example": "Argentina" }, "shipping_tracking": { "type": "string", "example": "TRK123456789" }, "meli_order_id": { "type": "integer", "example": 2000016090087160 }, "meli_pack_id": { "type": "integer", "example": 2000012622686899, "nullable": true }, "meli_shipping_id": { "type": "integer", "example": 46905049510 }, "meli_buyer_nickname": { "type": "string", "example": "JD_NICKNAME" }, "meli_status": { "type": "string", "example": "paid" }, "integration_origin_id": { "type": "string", "example": "2000016090087160" }, "integration_origin_sub_id": { "type": "string", "example": "2000012622686899" }, "integration_erp_order_id": { "type": "string", "example": "ERP-12345", "nullable": true }, "created_at": { "type": "string", "format": "date-time", "example": "2026-04-21 23:48:07" }, "updated_at": { "type": "string", "format": "date-time", "example": "2026-04-21 23:48:15" }, "business_name": { "type": "string", "example": "MY_BUSINESS" }, "channel_friendly_name": { "type": "string", "example": "Mercado Libre" }, "channel_logo_url": { "type": "string", "example": "https://static.intrasistema.com/images/mercadolibre-icon-20x20.png" }, "created_by_username": { "type": "string", "example": "admin", "nullable": true }, "modified_by_username": { "type": "string", "nullable": true } }, "type": "object" }, "Outbound": { "title": "Outbound Object", "description": "Details of an outbound order", "properties": { "id": { "description": "Unique identifier for the outbound order", "type": "string" }, "business_id": { "description": "Business ID of the order owner", "type": "string" } }, "type": "object" }, "Outbounds": { "title": "Outbound Object", "description": "Details of a outbound order", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" } }, "type": "object" }, "Outobunds": { "title": "outbound Object", "description": "Details of a outbound order", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" } }, "type": "object" }, "PickingBatchOrderDetail": { "title": "Picking Batch Order Detail Object", "description": "Details of a picking pending order", "properties": { "order_id": { "description": "Order ID", "type": "integer" }, "business_id": { "description": "Business ID", "type": "integer" }, "shipping": { "description": "Shipping method", "type": "string" }, "shipping_date_fulfillment_limit": { "description": "Shipping date fulfillment limit", "type": "string", "format": "date" }, "total_units": { "description": "Total units in the order", "type": "integer" }, "total_weight": { "description": "Total weight of the order", "type": "integer" }, "overweight": { "description": "Overweight indicator", "type": "integer" }, "sufficient_stock": { "description": "Sufficient stock indicator", "type": "integer" } }, "type": "object" }, "PickingManualResponse": { "title": "Picking Manual Response", "description": "Response after manual batch creation", "properties": { "error": { "description": "Error flag (0 for success, 1 for error)", "type": "integer" }, "message": { "description": "Summary message of the operation", "type": "string" } }, "type": "object" }, "Picking": { "title": "Picking Object", "description": "Details of a outbound order", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" } }, "type": "object" }, "ShipmentDetails": { "properties": { "substatus_history": { "type": "array", "items": { "properties": { "date": { "type": "string", "format": "date-time" }, "substatus": { "type": "string" }, "status": { "type": "string" } }, "type": "object" } }, "snapshot_packing": { "properties": { "snapshot_id": { "type": "string" }, "pack_hash": { "type": "string" } }, "type": "object" }, "receiver_id": { "type": "integer" }, "base_cost": { "type": "number" }, "status_history": { "properties": { "date_shipped": { "type": "string", "format": "date-time" }, "date_returned": { "type": "string", "format": "date-time" }, "date_delivered": { "type": "string", "format": "date-time" }, "date_first_visit": { "type": "string", "format": "date-time" }, "date_not_delivered": { "type": "string", "format": "date-time" }, "date_cancelled": { "type": "string", "format": "date-time" }, "date_handling": { "type": "string", "format": "date-time" }, "date_ready_to_ship": { "type": "string", "format": "date-time" } }, "type": "object" }, "type": { "type": "string" }, "return_details": { "type": "object", "nullable": true }, "sender_id": { "type": "integer" }, "mode": { "type": "string" }, "order_cost": { "type": "number" }, "priority_class": { "properties": { "id": { "type": "integer", "nullable": true } }, "type": "object" }, "service_id": { "type": "integer" }, "shipping_items": { "type": "array", "items": { "properties": { "quantity": { "type": "integer" }, "dimensions_source": { "properties": { "origin": { "type": "string" }, "id": { "type": "string" } }, "type": "object" }, "description": { "type": "string" }, "id": { "type": "string" }, "user_product_id": { "type": "string" }, "sender_id": { "type": "integer" }, "dimensions": { "type": "string" } }, "type": "object" } }, "tracking_number": { "type": "string" }, "cost_components": { "properties": { "loyal_discount": { "type": "number" }, "special_discount": { "type": "number" }, "compensation": { "type": "number" }, "gap_discount": { "type": "number" }, "ratio": { "type": "number" } }, "type": "object" }, "id": { "type": "integer" }, "tracking_method": { "type": "string" }, "last_updated": { "type": "string", "format": "date-time" }, "items_types": { "type": "array", "items": { "type": "string" } }, "comments": { "type": "string", "nullable": true }, "substatus": { "type": "string" }, "date_created": { "type": "string", "format": "date-time" }, "date_first_printed": { "type": "string", "format": "date-time", "nullable": true }, "created_by": { "type": "string" }, "application_id": { "type": "string", "nullable": true }, "shipping_option": { "properties": { "processing_time": { "type": "integer" }, "cost": { "type": "number" }, "estimated_schedule_limit": { "properties": { "date": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "shipping_method_id": { "type": "integer" }, "estimated_delivery_final": { "properties": { "date": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" } }, "type": "object" }, "buffering": { "properties": { "date": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "pickup_promise": { "properties": { "from": { "type": "string", "format": "date-time", "nullable": true }, "to": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "list_cost": { "type": "number" }, "estimated_delivery_limit": { "properties": { "date": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" } }, "type": "object" }, "priority_class": { "properties": { "id": { "type": "integer", "nullable": true } }, "type": "object" }, "delivery_promise": { "type": "string" }, "delivery_type": { "type": "string" }, "estimated_handling_limit": { "properties": { "date": { "type": "string", "format": "date-time", "nullable": true } }, "type": "object" }, "estimated_delivery_time": { "properties": { "date": { "type": "string", "format": "date-time" }, "pay_before": { "type": "string", "format": "date-time" }, "schedule": { "type": "string", "nullable": true }, "unit": { "type": "string" }, "offset": { "type": "object" }, "shipping": { "type": "integer" }, "time_frame": { "properties": { "from": { "type": "string", "nullable": true }, "to": { "type": "string", "nullable": true } }, "type": "object" }, "handling": { "type": "integer" }, "type": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "id": { "type": "integer" }, "estimated_delivery_extended": { "properties": { "date": { "type": "string", "format": "date-time" }, "offset": { "type": "integer" } }, "type": "object" }, "currency_id": { "type": "string" } }, "type": "object" }, "tags": { "type": "array", "items": { "type": "string" } }, "sender_address": { "properties": { "country": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "address_line": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "city": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "geolocation_type": { "type": "string", "nullable": true }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "type": "object" }, "receiver_address": { "properties": { "country": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "address_line": { "type": "string" }, "types": { "type": "array", "items": { "type": "string" } }, "city": { "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "type": "object" }, "latitude": { "type": "number" }, "longitude": { "type": "number" } }, "type": "object" } }, "type": "object" }, "Shipment": { "properties": { "mercadolibre": { "properties": { "shipments": { "type": "array", "items": { "$ref": "#/components/schemas/ShipmentDetails" } } }, "type": "object" }, "is": { "properties": { "orders": { "properties": { "id": { "type": "integer", "example": 12096529 } }, "type": "object" } }, "type": "object" } }, "type": "object" }, "Thread": { "title": "Thread Object", "description": "Details of a message thread", "properties": { "id": { "description": "Unique identifier for the thread", "type": "string" }, "business_id": { "description": "Business ID of the thread owner", "type": "string" }, "integration_id": { "description": "Integration ID of the thread", "type": "string" }, "integration_credential_id": { "description": "Integration credential ID of the thread", "type": "string" }, "channel_id": { "description": "Channel ID of the thread", "type": "string" }, "channel_sub_id": { "description": "Sub-channel ID of the thread", "type": "string" }, "channel_category": { "description": "Category of the channel", "type": "string" }, "from_name": { "description": "Sender's name", "type": "string" }, "from_id": { "description": "Sender's ID or email", "type": "string" }, "to_name": { "description": "Recipient's name", "type": "string" }, "to_id": { "description": "Recipient's ID or email", "type": "string" }, "subject": { "description": "Subject of the thread", "type": "string" }, "status": { "description": "Current status of the thread", "type": "string" }, "created_by": { "description": "User who created the thread", "type": "string" }, "created_at": { "description": "Date and time when the thread was created", "type": "string", "format": "date-time" }, "updated_at": { "description": "Date and time of the last update", "type": "string", "format": "date-time" }, "tags": { "description": "Tags associated with the thread", "type": "string" }, "business_name": { "description": "Business name associated with the thread", "type": "string" } }, "type": "object" }, "Thread-Tags": { "title": "Thread Object", "description": "Tags", "properties": { "id": { "type": "integer" }, "thread_id": { "type": "integer" }, "tag": { "type": "string" } }, "type": "object" } }, "securitySchemes": { "apiKey": { "type": "apiKey", "name": "X-API-KEY", "in": "header" } } }, "tags": [ { "name": "Automation" }, { "name": "Orders" }, { "name": "Inventory" }, { "name": "Items" }, { "name": "Shipments" }, { "name": "Tracking" }, { "name": "Inbounds" }, { "name": "Outbounds" }, { "name": "Picking" }, { "name": "Packing" }, { "name": "Printers" }, { "name": "Documents" }, { "name": "Buyers" }, { "name": "Integrations" }, { "name": "Websockets" }, { "name": "Business" }, { "name": "Contact Form" }, { "name": "Crm" }, { "name": "Customers" }, { "name": "Dashboards" }, { "name": "Fulfillment" }, { "name": "Images" }, { "name": "Items:Stock" }, { "name": "Log" }, { "name": "Network" }, { "name": "NPS" }, { "name": "Payments" }, { "name": "Putback" }, { "name": "Reports" }, { "name": "Returns" }, { "name": "Wms" }, { "name": "Stats" }, { "name": "Templates" }, { "name": "Users" }, { "name": "Warehouses" } ] }