This documentation exposes a collection of APIs that can be used by sellers to integrate with the services offered by Melonn.
\n\n\n🚧 This documentation is under construction, if you need to find more information you can check it out at learn with Melonn
\n
This is your complete guide to integrating with Melonn’s fulfillment platform.
You will find:
A detailed description of the available functionalities, related with order creation, products, inventory, shipping tracking and some others.
\nAn overview of the business flows supported by the API.
\nThe full list of webhooks and endpoints with request/response examples, designed to help you get started quickly.
Our goal is to provide you with everything you need to build a smooth, secure, and scalable integration between your systems and Melonn.
\n\n🚧 We currently cover topics related to Sales Orders, Buyer Return Orders and Products (PIM) in this documentation, but we'll be adding more information about the actions you can perform with our API soon.
\n
You must provide a token in each request that you must generate in Orbita platform going to Integrations -> API and this must be sent in the headers of each request as x-api-key
\n\n‼️ All endpoints have a request limit of 1 request per second. If you reach this limit then you will receive an status code: 429 and the request will be rejected.
\n
Before you start testing your integration with our API, you can use the sandbox environment provided by Melonn to experiment and test all the API functionalities without affecting real data from your business. Once you have tested that everything works fine, you just need to switch to the production environment.
\nKeep https://api.orbita.melonn.com if you are using a production.
Use https://api.orbita-qa.melonn.com for sandboxes or test your API integrations.
The API domain should be used in the {{api_url}} variable.
📌 Bundle: Grouping multiple items into a single SKU. This allows you to set up your sales channel selling a single SKU but have your inventory unconsolidated in Melonn. It does not imply that Melonn has to consolidate these items in any particular way during packaging.
\n📌 CEDIS: Melonn distribution centers, warehouses or storage facilities.
\n📌 Shipping Method: Used to deliver an order from the warehouse to the final destination. Each shipping method determines the carrier, delivery time frame, and logistics conditions (e.g., same-day delivery, standard delivery, pickup, or express service).
\n📌 Destination: These are your own stores, retailers or distributors to whom you will send the merchandise for B2B orders. Each of these may have one or more delivery points.
\n📌 D2C Orders: D2C orders are those that are usually placed by an individual customer and usually have a low quantity of items.
\n📌 KIT: It is a bundle that also includes some additional packaging preparation (placing items in a box or bag, closing with a sticker, heat shrinking).
\n📌 VAS - Value added services: Additional services to the traditional fulfillment concepts of storage, preparation and transportation.
\nMore details about VAS here
\nThe creation of a B2B order is directly linked to the business property, once it is included in the body of the request certain fields will be required to satisfy the creation data.
\n{ \"business\": { \"id\": \"ID\", \"delivery_location_id\": \"ID\" } }\n\nBy including the business object in the body of your request we will immediately mark this order as B2B and set the warehouse_code field as required.
This endpoint retrieves the details of a sell order based on the external order number.
\nexternal_order_number (path): The external order number for which the details are to be retrieved.
fields (query, optional): Comma-separated list of additional fields to include in the response. Available options:
sell_order_promises: Includes promise information and delivery attemptsThe response will contain the details of the sell order, including order information, buyer details, line items, shipping information, and optionally promise information when requested.
\nWhen fields=sell_order_promises is included in the request, the response will contain additional promise-related information:
sell_order_promise_info: Contains promise details including estimated delivery dates More info
\nsell_order_attempt: Contains information about delivery attempts and promises of delivered More info
\nOptional field to include sell order promises information
\n","type":"text/plain"},"key":"fields","value":"sell_order_promises"}],"variable":[{"type":"any","value":"702-4774540-6683432","key":"external_order_number"}]}},"response":[{"id":"653d4f67-bc0f-4ed7-ad79-e2d592f4dd63","name":"Ok D2C","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/sell-orders/:external_order_number","host":["{{api_url}}"],"path":["sell-orders",":external_order_number"],"variable":[{"key":"external_order_number","value":"TESTING-PUBLIC-API_D2C_001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 18 Dec 2024 18:47:27 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"783"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"184bd288-c898-4136-997c-4fd953b650c0"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"3f394993-f0ec-4bff-b8ec-add759609769"},{"key":"x-amzn-Remapped-Content-Length","value":"783"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Wed, 18 Dec 2024 18:47:27 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"DADN7FBGoAMEAfA="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"783"},{"key":"X-Amzn-Trace-Id","value":"Root=1-676318bf-12dce8d6784fe29042828743"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Wed, 18 Dec 2024 18:47:27 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"buyer\": {\n \"email\": \"krrskl@melonn.com\",\n \"full_name\": \"Testing\",\n \"phone_number\": \"+57-3045336862\"\n },\n \"id\": 1732571663793215,\n \"internal_order_number\": \"M1732571663793215\",\n \"external_order_id\": null,\n \"external_order_number\": \"TESTING-PUBLIC-API_D2C_001\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1732571663793215\",\n \"payment_on_delivery_amount\": null,\n \"is_b2b\": false,\n \"creation_date\": \"2024-11-25T21:54:25.000Z\",\n \"tags\": [\n \"TESTING-RC\"\n ],\n \"sell_order_state\": {\n \"id\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"sku\": \"S0001\"\n }\n ],\n \"shipping_method\": {\n \"code\": \"MEL-15\",\n \"name\": \"Estándar (Local y Nacional)\"\n },\n \"warehouse\": {\n \"address_line1\": \"Calle 55 sur # 44-76\",\n \"address_line2\": null,\n \"city\": \"Sabaneta\",\n \"country\": \"Colombia\",\n \"postal_code_id\": 1,\n \"region\": \"ANTIOQUIA\"\n }\n}"},{"id":"aa37b49b-e125-469d-afa9-c589d4c7e9cd","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"x-melonn-context","value":"{ \"user\": { \"email\": \"juan.camargo@melonn.com\", \"role\": \"seller\", \"user_id\": 342, \"user_metadata\": { \"seller\": { \"id\": 71 } } } }"}],"url":{"raw":"{{api_url}}/sell-orders/:external_order_number","host":["{{api_url}}"],"path":["sell-orders",":external_order_number"],"variable":[{"key":"external_order_number","value":"EST_ADDRESS_L2_01"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"66"},{"key":"Date","value":"Tue, 03 Dec 2024 03:53:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order not found\"\n}"}],"_postman_id":"07437da9-abd9-4c3e-9600-a3ff1bc27f01"},{"name":"Get B2B order","id":"30a4f228-f8e5-4ad5-ac9a-f14ea922563b","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/sell-orders/:external_order_number","description":"This endpoint retrieves the details of a sell order based on the external order number.
\nexternal_order_number (path): The external order number for which the details are to be retrieved.
fields (query, optional): Comma-separated list of additional fields to include in the response. Available options:
sell_order_promises: Includes promise information and delivery attemptsThe response will contain the details of the sell order, including order information, buyer details, line items, shipping information, and optionally promise information when requested.
\nWhen fields=sell_order_promises is included in the request, the response will contain additional promise-related information:
sell_order_promise_info: Contains promise details including estimated delivery dates More info
\nsell_order_attempt: Contains information about delivery attempts and promises of delivered More info
\nOptional field to include sell order promises information
\n","type":"text/plain"},"key":"fields","value":"sell_order_promises"}],"variable":[{"id":"1b992a4b-8982-4483-9d2f-23e6b04bfa67","type":"any","value":"702-4774540-6683432","key":"external_order_number"}]}},"response":[{"id":"bd6d45d8-2c21-47e2-baac-531316f1f969","name":"Ok B2B","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/sell-orders/:external_order_number","host":["{{api_url}}"],"path":["sell-orders",":external_order_number"],"variable":[{"key":"external_order_number","value":"EST_ADDRESS_L2_01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"927"},{"key":"Date","value":"Tue, 03 Dec 2024 03:39:45 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"business\": {\n \"external_id\": \"167\",\n \"name\": \"Comprador B2B 01\",\n \"business_delivery_location\": {\n \"id\": 222,\n \"name\": \"Edficio Cortezza\"\n }\n },\n \"buyer\": {\n \"email\": \"brayan@melonn.com\",\n \"full_name\": \"Comprador B2B 01\",\n \"phone_number\": \"+573007444471\"\n },\n \"id\": 1734382854186519,\n \"internal_order_number\": \"M1734382854186519\",\n \"external_order_id\": \"TESTING-PUBLIC-API-PAO-IMG\",\n \"external_order_number\": \"TESTING-PUBLIC-API-PAO-IMG\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1734382854186519\",\n \"payment_on_delivery_amount\": 0,\n \"is_b2b\": true,\n \"creation_date\": \"2024-12-16T21:00:54.000Z\",\n \"tags\": [\n \"TESTING-RC\"\n ],\n \"sell_order_vas\": [\n {\n \"code\": \"10\",\n \"name\": \"Etiquetado de cada paquete.\",\n \"comments\": [],\n \"files\": []\n }\n ],\n \"sell_order_state\": {\n \"id\": 26,\n \"name\": \"All items reserved - fulfillment on hold\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"sku\": \"S0001\"\n }\n ],\n \"shipping_method\": {\n \"code\": \"MEL-13\",\n \"name\": \"Recogida\"\n },\n \"warehouse\": {\n \"address_line1\": \"Calle 55 sur # 44-76\",\n \"address_line2\": null,\n \"city\": \"Sabaneta\",\n \"country\": \"Colombia\",\n \"postal_code_id\": 1,\n \"region\": \"ANTIOQUIA\"\n }\n}"},{"id":"dc49d89d-ec33-4379-9ecf-9573a31aa1d2","name":"Resource not found","originalRequest":{"method":"GET","header":[{"key":"x-melonn-context","value":"{ \"user\": { \"email\": \"juan.camargo@melonn.com\", \"role\": \"seller\", \"user_id\": 342, \"user_metadata\": { \"seller\": { \"id\": 71 } } } }"}],"url":{"raw":"{{api_url}}/sell-orders/:external_order_number","host":["{{api_url}}"],"path":["sell-orders",":external_order_number"],"variable":[{"key":"external_order_number","value":"EST_ADDRESS_L2_01"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"66"},{"key":"Date","value":"Tue, 03 Dec 2024 03:53:39 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order not found\"\n}"},{"id":"c2947b28-9516-4eaa-9a95-495f861261bf","name":"Ok B2B with Promises","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/sell-orders/:external_order_number?fields=sell_order_promises","host":["{{api_url}}"],"path":["sell-orders",":external_order_number"],"query":[{"key":"fields","value":"sell_order_promises"}],"variable":[{"key":"external_order_number","value":"TEST_BUSINESS_RULES_0001"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"business\": {\n \"external_id\": \"167\",\n \"name\": \"Comprador B2B 01\",\n \"business_delivery_location\": {\n \"id\": 222,\n \"name\": \"Edficio Cortezza\"\n }\n },\n \"buyer\": {\n \"email\": \"brayan@melonn.com\",\n \"full_name\": \"Comprador B2B 01\",\n \"phone_number\": \"+573007444471\"\n },\n \"id\": 1734382854186519,\n \"internal_order_number\": \"M1734382854186519\",\n \"external_order_id\": \"TEST_PROMISES_001\",\n \"external_order_number\": \"TEST_PROMISES_001\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1734382854186519\",\n \"payment_on_delivery_amount\": 0,\n \"is_b2b\": true,\n \"creation_date\": \"2025-10-01T21:00:54.000Z\",\n \"tags\": [\n \"TESTING-RC\"\n ],\n \"sell_order_vas\": [\n {\n \"code\": \"10\",\n \"name\": \"Etiquetado de cada paquete.\",\n \"comments\": [],\n \"files\": []\n }\n ],\n \"sell_order_state\": {\n \"id\": 26,\n \"name\": \"All items reserved - fulfillment on hold\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"sku\": \"S0001\"\n }\n ],\n \"shipping_method\": {\n \"code\": \"MEL-13\",\n \"name\": \"Recogida\"\n },\n \"warehouse\": {\n \"address_line1\": \"Calle 55 sur # 44-76\",\n \"address_line2\": null,\n \"city\": \"Sabaneta\",\n \"country\": \"Colombia\",\n \"postal_code_id\": 1,\n \"region\": \"ANTIOQUIA\"\n },\n \"sell_order_promise_info\": {\n \"promise_source\": \"MELONN\",\n \"external_promise_info\": {\n \"promise_type\": \"DELIVERY\",\n \"promise_value\": {\n \"max\": \"2025-05-20 01:30:00\"\n }\n },\n \"pack_ready_to_sort_promise_min\": \"2025-12-17T08:00:00.000Z\",\n \"pack_ready_to_sort_promise_max\": \"2025-12-17T18:00:00.000Z\",\n \"pack_ready_to_sort_promise_processing_date\": \"2025-12-16T21:05:00.000Z\",\n \"pack_ready_to_sort_timestamp\": \"2025-12-17T10:30:00.000Z\",\n \"unpack_promise_min\": \"2025-12-18T08:00:00.000Z\",\n \"unpack_promise_max\": \"2025-12-18T18:00:00.000Z\",\n \"unpack_promise_processing_date\": \"2025-12-17T10:30:00.000Z\",\n \"unpack_timestamp\": \"2025-12-18T14:15:00.000Z\",\n \"unpack_cancelation_promise_min\": null,\n \"unpack_cancelation_promise_max\": null,\n \"unpack_cancelation_promise_processing_date\": null,\n \"unpack_cancelation_timestamp\": null\n },\n \"sell_order_attempt\": [{\n \"current\": true,\n \"ready_to_ship_promise_min\": \"2025-12-17T08:00:00.000Z\",\n \"ready_to_ship_promise_max\": \"2025-12-17T18:00:00.000Z\",\n \"ready_to_ship_promise_processing_date\": \"2025-12-16T21:05:00.000Z\",\n \"ready_to_ship_timestamp\": \"2025-12-17T10:30:00.000Z\",\n \"ship_promise_min\": \"2025-12-18T08:00:00.000Z\",\n \"ship_promise_max\": \"2025-12-18T18:00:00.000Z\",\n \"ship_promise_processing_date\": \"2025-12-17T10:30:00.000Z\",\n \"ship_timestamp\": \"2025-12-18T14:15:00.000Z\",\n \"delivery_promise_min\": \"2025-12-20T08:00:00.000Z\",\n \"delivery_promise_max\": \"2025-12-20T18:00:00.000Z\",\n \"delivery_promise_processing_date\": \"2025-12-18T14:15:00.000Z\",\n \"delivery_timestamp\": null,\n \"ready_to_pickup_promise_min\": null,\n \"ready_to_pickup_promise_max\": null,\n \"ready_to_pickup_processing_date\": null,\n \"ready_to_pickup_timestamp\": null,\n \"pickup_promise_min\": null,\n \"pickup_promise_max\": null,\n \"pickup_promise_processing_date\": null,\n \"pickup_timestamp\": null\n }]\n}"}],"_postman_id":"30a4f228-f8e5-4ad5-ac9a-f14ea922563b"},{"name":"Get order list","event":[{"listen":"prerequest","script":{"id":"80d89779-9d5b-47e4-b5e4-f1023816ed16","exec":[""],"type":"text/javascript","packages":{},"requests":{}}}],"id":"bd048c94-e32b-45d6-9acd-f5c6caa534f0","protocolProfileBehavior":{"disabledSystemHeaders":{},"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/sell-orders?initial_creation_date=2025-12-10T19:22:08.000Z","description":"This endpoint retrieves list of sell orders
\nfields (query, optional): Comma-separated list of additional fields to include in the response. Available options:
page: Number of page from pagination
per_page: Number of items per page
sell_order_state_codes: Array of order state codes - Format [1,3]
initial_creation_date : Orders created >= initial_creation_date - Format ISO 8601
final_creation_date : Orders created <= final_creation_date - Format ISO 8601
The response will contain list of sell orders basic info. For more specific details, request Get Order resource
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}},"urlObject":{"path":["sell-orders"],"host":["{{api_url}}"],"query":[{"disabled":true,"description":{"content":"Pagination Param
\n","type":"text/plain"},"key":"page","value":"0"},{"disabled":true,"description":{"content":"Items Per Page
\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"Sell order state codes
\n","type":"text/plain"},"key":"sell_order_state_codes","value":"[3,28]"},{"key":"initial_creation_date","value":"2025-12-10T19:22:08.000Z"},{"disabled":true,"key":"final_creation_date","value":"2025-12-13T19:22:08.000Z"}],"variable":[]}},"response":[{"id":"ca25bb22-c40e-4e68-b2a5-d65040df3eb7","name":"Get order list","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/sell-orders","host":["{{api_url}}"],"path":["sell-orders"],"query":[{"key":"page","value":"0","description":"Pagination Param","type":"text","disabled":true},{"key":"per_page","value":"10","description":"Items Per Page","type":"text","disabled":true},{"key":"sell_order_state_codes","value":"[3,28]","description":"Sell order state codes","type":"text","disabled":true},{"key":"initial_creation_date","value":"2025-12-10T19:22:08.000Z","disabled":true},{"key":"final_creation_date","value":"2025-12-13T19:22:08.000Z","type":"text","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Thu, 11 Dec 2025 21:11:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2459"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"8087e334-50ef-4617-b347-25ca67bc933c"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"eb381ca8-cb3c-4288-a3d8-5e9edc36fcec"},{"key":"x-amzn-Remapped-Content-Length","value":"2459"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Thu, 11 Dec 2025 21:11:05 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"VcT3-H4yIAMESsw="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"2459"},{"key":"X-Amzn-Trace-Id","value":"Root=1-693b3365-157ca16447f5fc392929eee1"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Thu, 11 Dec 2025 21:11:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 1765485926468311,\n \"internal_order_number\": \"M1765485926468311\",\n \"external_order_number\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"external_order_id\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1765485926468311\",\n \"payment_on_delivery_amount\": null,\n \"payment_on_delivery_type\": null,\n \"is_b2b\": false,\n \"creation_date\": \"2025-12-11T20:45:28.000Z\",\n \"shipping_method\": {\n \"code\": \"FP-5\",\n \"name\": \"Siguiente día hábil local\"\n },\n \"warehouse\": {\n \"code\": \"MED1\",\n \"name\": \"Medellin #1\"\n },\n \"sell_order_state\": {\n \"code\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n }\n },\n {\n \"id\": 1765471053187852,\n \"internal_order_number\": \"M1765471053187852\",\n \"external_order_number\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"external_order_id\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1765471053187852\",\n \"payment_on_delivery_amount\": null,\n \"payment_on_delivery_type\": null,\n \"is_b2b\": false,\n \"creation_date\": \"2025-12-11T16:37:33.000Z\",\n \"shipping_method\": {\n \"code\": \"FP-5\",\n \"name\": \"Siguiente día hábil local\"\n },\n \"warehouse\": {\n \"code\": \"MED1\",\n \"name\": \"Medellin #1\"\n },\n \"sell_order_state\": {\n \"code\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n }\n },\n {\n \"id\": 1765471041767433,\n \"internal_order_number\": \"M1765471041767433\",\n \"external_order_number\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"external_order_id\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1765471041767433\",\n \"payment_on_delivery_amount\": null,\n \"payment_on_delivery_type\": null,\n \"is_b2b\": false,\n \"creation_date\": \"2025-12-11T16:37:23.000Z\",\n \"shipping_method\": {\n \"code\": \"FP-5\",\n \"name\": \"Siguiente día hábil local\"\n },\n \"warehouse\": {\n \"code\": \"MED1\",\n \"name\": \"Medellin #1\"\n },\n \"sell_order_state\": {\n \"code\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n }\n },\n {\n \"id\": 1765469803582701,\n \"internal_order_number\": \"M1765469803582701\",\n \"external_order_number\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"external_order_id\": \"TESTING_PAYMENT_ON_DELIVERY_AMOUNT_RC\",\n \"melonn_tracking_link\": \"https://d31a8gq0kszthp.cloudfront.net/M1765469803582701\",\n \"payment_on_delivery_amount\": null,\n \"payment_on_delivery_type\": null,\n \"is_b2b\": false,\n \"creation_date\": \"2025-12-11T16:16:45.000Z\",\n \"shipping_method\": {\n \"code\": \"FP-5\",\n \"name\": \"Siguiente día hábil local\"\n },\n \"warehouse\": {\n \"code\": \"MED1\",\n \"name\": \"Medellin #1\"\n },\n \"sell_order_state\": {\n \"code\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n }\n }\n ],\n \"meta_data\": {\n \"page\": 0,\n \"per_page\": 10,\n \"total_count\": 4\n }\n}"}],"_postman_id":"bd048c94-e32b-45d6-9acd-f5c6caa534f0"},{"name":"Release hold fulfillment","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","packages":{},"id":"17b86e00-db7c-41ef-a96e-5d720b58f137"}}],"id":"eb362cbb-148b-4fd1-843c-492efcaf306c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipping_method_code\": \"\" // string | undefined\n}","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/sell-orders/:external_order_number/release-hold-fulfillment","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}},"urlObject":{"path":["sell-orders",":external_order_number","release-hold-fulfillment"],"host":["{{api_url}}"],"query":[],"variable":[{"id":"29a56363-8d37-476d-8631-cc636dce04ca","type":"any","value":"1661-01","key":"external_order_number"}]}},"response":[{"id":"460f4cd5-b307-4946-a6ef-c037b9759608","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipping_method_code\": \"TEST\" // string | undefined\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/sell-orders/:external_order_number/release-hold-fulfillment","host":["{{api_url}}"],"path":["sell-orders",":external_order_number","release-hold-fulfillment"],"variable":[{"key":"external_order_number","value":"1661-01"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"0"},{"key":"Date","value":"Tue, 07 Jan 2025 14:48:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"},{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Order released successfully\"\n}"},{"id":"82ac61d7-182f-429d-8cd2-dde1d74e6ba9","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipping_method_code\": \"\" // string | undefined\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/sell-orders/:external_order_number/release-hold-fulfillment","host":["{{api_url}}"],"path":["sell-orders",":external_order_number","release-hold-fulfillment"],"variable":[{"key":"external_order_number","value":"TEST_BUSINESS_RULES_0001"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 16:50:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0e6e616d-8cab-4e25-a811-e35b96c358e0"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"fea6ff0b-303f-40bf-bea4-0ff4f8904a11"},{"key":"x-amzn-Remapped-Content-Length","value":"38"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Tue, 07 Jan 2025 16:50:05 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"EBsxGGY3IAMEiRw="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"38"},{"key":"X-Amzn-Trace-Id","value":"Root=1-677d5b39-20c59ccc1f6e3ad7351196ff;Sampled=1;Lineage=1:744d1f37:0"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Tue, 07 Jan 2025 16:50:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Sell Order invalid state\"\n}"},{"id":"038c32d1-8e14-4261-85a2-ef1e8be647bd","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipping_method_code\": \"TEST\" // string | undefined\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api_url}}/sell-orders/:external_order_number/release-hold-fulfillment","host":["{{api_url}}"],"path":["sell-orders",":external_order_number","release-hold-fulfillment"],"variable":[{"key":"external_order_number","value":"1661-01"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"39"},{"key":"Date","value":"Tue, 07 Jan 2025 14:49:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Shipping method not found\"\n}"}],"_postman_id":"eb362cbb-148b-4fd1-843c-492efcaf306c"}],"id":"3e5fe41d-7cde-4d65-a8bd-5f28fa3a7372","description":"This API exposes a set of methods related to sales orders.
\nCreating a sell order requires a set of basic data regardless of the type of order you want to create (B2B or D2C).
\nBusiness email
\n","type":"text/plain"},"key":"email","value":"krrskl@melonn.com"}],"variable":[]}},"response":[{"id":"f2a3aef0-4a01-43b2-a744-7b41cd02e490","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/business","host":["{{api_url}}"],"path":["business"],"query":[{"key":"email","value":null,"disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"8893"},{"key":"Date","value":"Tue, 14 Jan 2025 12:57:23 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"3726016736-OLD\",\n \"name\": \"B2B Int 01\",\n \"email\": \"saleschannels@melonn.com\",\n \"phone_number\": \"\",\n \"delivery_locations\": []\n },\n {\n \"id\": \"186\",\n \"name\": \"b2btest2\",\n \"email\": null,\n \"phone_number\": \"+573192821788\",\n \"delivery_locations\": [\n {\n \"id\": \"7009239264-1\",\n \"address_l1\": \"Carrera 82\",\n \"email\": \"krrskl@melonn.com\",\n \"name\": \"Carrera 82\",\n \"phone_number\": \"+573192821788\"\n }\n ]\n }\n]"}],"_postman_id":"a2c330da-e24a-4f00-8187-25ec3b01a563"},{"name":"Create in bulk","id":"4dbf2d97-d670-471e-b4bd-862c2df94c59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"country_id\": 1,\n \"email\": \"example@business.com\",\n \"external_id\": \"BUS123\",\n \"logo_url\": \"https://ssl.gstatic.com/calendar/images/dynamiclogo_2020q4/calendar_27_2x.png\",\n \"name\": \"Ejemplo Business\",\n \"phone_number\": \"+57345637890\",\n \"website\": \"https://example.com\",\n \"business_delivery_locations\": [\n {\n \"external_id\": \"LOC123\",\n \"name\": \"Sucursal Centro\",\n \"address_l1\": \"Calle 48 #26\",\n \"address_l2\": \"Casa 20\",\n \"phone_number\": \"+573459967891\",\n \"location_info\": {\n \"city\": \"Santa Marta\",\n \"region\": \"Magdalena\",\n \"country\": \"Colombia\",\n \"postal_code\": \"470003\"\n }\n }\n ],\n \"business_vas\": []\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/business","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}},"urlObject":{"path":["business"],"host":["{{api_url}}"],"query":[],"variable":[]}},"response":[{"id":"df8730c4-ed1f-48a2-93b5-6a757272c09d","name":"Ok","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"country_id\": 1,\n \"email\": \"example@business.com\",\n \"external_id\": \"BUS123\",\n \"logo_url\": \"https://ssl.gstatic.com/calendar/images/dynamiclogo_2020q4/calendar_27_2x.png\",\n \"name\": \"Ejemplo Business\",\n \"phone_number\": \"+57345637890\",\n \"website\": \"https://example.com\",\n \"business_delivery_locations\": [\n {\n \"external_id\": \"LOC123\",\n \"name\": \"Sucursal Centro\",\n \"address_l1\": \"Calle 48 #26\",\n \"address_l2\": \"Casa 20\",\n \"phone_number\": \"+573459967891\",\n \"location_info\": {\n \"city\": \"Santa Marta\",\n \"region\": \"Magdalena\",\n \"country\": \"Colombia\",\n \"postal_code\": \"470003\"\n }\n }\n ],\n \"business_vas\": []\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/business"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"content-length","value":"0"},{"key":"Date","value":"Tue, 07 Jan 2025 14:48:13 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"},{"key":"Content-Type","value":"application/json","description":""}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Businesses created successfully\"\n}"},{"id":"837cb84b-0392-4734-80ab-6647054bee1e","name":"Bad request","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"country_id\": 1,\n \"email\": \"example@business.com\",\n \"external_id\": \"BUS123\",\n \"logo_url\": \"https://ssl.gstatic.com/calendar/images/dynamiclogo_2020q4/calendar_27_2x.png\",\n \"name\": \"Ejemplo Business\",\n \"phone_number\": \"+57345637890\",\n \"website\": \"https://example.com\",\n \"business_delivery_locations\": [\n {\n \"external_id\": \"LOC123\",\n \"name\": \"Sucursal Centro\",\n \"address_l1\": \"Calle 48 #26\",\n \"address_l2\": \"Casa 20\",\n \"phone_number\": \"+573459967891\",\n \"location_info\": {\n \"city\": \"Santa Marta\",\n \"region\": \"Magdalena\",\n \"country\": \"Colombia\",\n \"postal_code\": \"470003\"\n }\n }\n ],\n \"business_vas\": []\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/business"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 07 Jan 2025 16:50:05 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"38"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"0e6e616d-8cab-4e25-a811-e35b96c358e0"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"fea6ff0b-303f-40bf-bea4-0ff4f8904a11"},{"key":"x-amzn-Remapped-Content-Length","value":"38"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Tue, 07 Jan 2025 16:50:05 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"EBsxGGY3IAMEiRw="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"38"},{"key":"X-Amzn-Trace-Id","value":"Root=1-677d5b39-20c59ccc1f6e3ad7351196ff;Sampled=1;Lineage=1:744d1f37:0"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Tue, 07 Jan 2025 16:50:05 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"Error uploading file:\"\n}"},{"id":"f4d2ceeb-7b61-4627-b9df-115fabcc8a97","name":"Resource not found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"country_id\": 1,\n \"email\": \"example@business.com\",\n \"external_id\": \"BUS123\",\n \"logo_url\": \"https://ssl.gstatic.com/calendar/images/dynamiclogo_2020q4/calendar_27_2x.png\",\n \"name\": \"Ejemplo Business\",\n \"phone_number\": \"+57345637890\",\n \"website\": \"https://example.com\",\n \"business_delivery_locations\": [\n {\n \"external_id\": \"LOC123\",\n \"name\": \"Sucursal Centro\",\n \"address_l1\": \"Calle 48 #26\",\n \"address_l2\": \"Casa 20\",\n \"phone_number\": \"+573459967891\",\n \"location_info\": {\n \"city\": \"Santa Marta\",\n \"region\": \"Magdalena\",\n \"country\": \"Colombia\",\n \"postal_code\": \"470003\"\n }\n }\n ],\n \"business_vas\": []\n }\n]","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/business"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"content-type","value":"application/json; charset=utf-8"},{"key":"content-length","value":"39"},{"key":"Date","value":"Tue, 07 Jan 2025 14:49:22 GMT"},{"key":"Connection","value":"keep-alive"},{"key":"Keep-Alive","value":"timeout=72"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"VAS not found: 21, 22\"\n}"}],"_postman_id":"4dbf2d97-d670-471e-b4bd-862c2df94c59"}],"id":"57bbe0be-9d4f-4c6b-9502-f35f12c7c222","event":[{"listen":"prerequest","script":{"type":"text/javascript","packages":{},"exec":["const melonnContext = pm.environment.get(\"x_melonn_context\");","","if (melonnContext?.length) {"," pm.request.addHeader({ key: \"x-melonn-context\", value: melonnContext });","}",""],"id":"2534124a-e537-4125-a3ad-58721270822f"}},{"listen":"test","script":{"type":"text/javascript","packages":{},"exec":[""],"id":"73980ada-c8d2-4bd6-aed2-39ae96509bb7"}}],"_postman_id":"57bbe0be-9d4f-4c6b-9502-f35f12c7c222","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}}},{"name":"Supplier orders","item":[{"name":"Create supplier order","id":"b293bb5a-4b49-4837-83f3-58718133dda0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{api_url}}/supplier-orders","description":"This API endpoint allows you to create a new supplier order to send inventory to a Melonn warehouse.
\nseller_supplier_id (integer, required) - ID of the seller's supplier.
destination_warehouse_code (string, required) - Code of the destination warehouse where the inventory will be received.
external_order_number (string, required) - External identifier for the supplier order.
tracking_number (string, required) - Courier tracking number for the shipment.
expected_reception_date (string, optional) - Expected date for the shipment to arrive at the warehouse (ISO 8601 format, e.g., 2025-01-31T00:00:00Z).
comments (string, required) - Comments or notes about the supplier order.
return_address_l1 (string, required) - Return address line 1 (in case items need to be returned to seller).
return_address_l2 (string, required) - Return address line 2 (additional address details).
return_city (string, required) - Return address city.
return_region (string, required) - Return address region or state.
return_country (string, required) - Return address country.
return_postal_code (string, required) - Return address postal code.
courier_company_id (integer, required) - ID of the courier company handling the shipment.
line_items (array, required) - List of products being sent. Each item includes:
sku (string, required) - SKU of the product.
qty_ordered (integer, required) - Quantity being sent.
expiration_date (string, optional) - Expiration date of the product (YYYY-MM-DD). Use a far future date for non-perishable items.
lot_number (string, optional) - Lot number for inventory control.
reception_services (array of codes, optional) - Codes of reception services (refer to Inbound reception service) requested for this item.
shipped_packages (array, required) - Information about the physical packages being shipped. Each package includes:
package_type (string, required) - Type of package being shipped. box or pallet
qty_packages_shipped (integer, required) - Number of packages of this type.
Retrieves a paginated list of supplier orders.
\npage (integer, optional) - Page number (default: 0).
per_page (integer, optional) - Items per page (default: 10, max: 100).
external_order_number (string, optional) - Filter by exact external order number.
internal_order_number (string, optional) - Filter by exact internal order number.
external_order_numbers (array[string], optional) - Filter by multiple external order numbers (e.g., ?external_order_numbers=[\"PO-001\",\"PO-002\"]).
supplier_order_state_id (array[integer], optional) - Filter by one or multiple state IDs (e.g., ?supplier_order_state_id=[1,2,4]).
warehouse_code (string, optional) - Filter by destination warehouse code.
The response contains two sections: data and meta.
data - Array of supplier orders. Each order includes:
id - Internal ID.
internal_order_number - Internal order number.
external_order_number - External identifier.
destination_warehouse_code - Destination warehouse code.
creation_date - Creation date.
comments - Order comments.
supplier_order_state - State information (code, description, closed).
Return address fields.
\nmeta - Pagination information:
page - Current page number.
per_page - Number of records per page.
Retrieves the details of a specific supplier order including line items and packages information.
\ninternal_order_number (string, required) - The internal order number (e.g., I00012345).The response contains detailed information about the supplier order:
\nid - Internal ID of the supplier order.
internal_order_number - Internal order number assigned by Melonn.
external_order_number - External identifier provided during creation.
destination_warehouse_code - Code of the destination warehouse.
creation_date - Date and time when the order was created.
comments - Order comments/notes.
return_address_l1, return_address_l2, return_city, return_region, return_country, return_postal_code - Return address details.
supplier_order_state - Object with state information:
code - State code (refer to Supplier Order States)
description - Human-readable state description.
closed - Boolean indicating if the order is in a final state.
supplier_order_lines - Array of line items:
sku - Product SKU.
original - Boolean indicating if this is an original line item (not added during reception).
qty_ordered - Quantity originally ordered.
qty_received_ok - Quantity received in good condition.
qty_received_defective - Quantity received in defective condition.
expiration_date - Product expiration date.
lot_number - Product lot number.
reception_services - Array of reception services:
reception_service_code - Reception service code.
requested_by_seller - Whether the service was requested by seller.
qty_executed - Quantity processed with this service (null if not executed).
supplier_order_packages - Array of packages:
internal_package_number - Internal package identifier.
reception_date - Date when the package was received at warehouse.
max_unpack_promise - Maximum promised date for unpacking.
unpacking_end_date - Date when unpacking was completed.
Cancels an existing supplier order. This action is only valid for orders in specific states.
\ninternal_order_number (string, required) - The internal order number to cancel.Orders in other states cannot be cancelled.
\n*Note: Although no request body is required for this operation, including the Content-Type: application/json header without a corresponding payload will result in a 400 error, as the server expects a valid JSON body when this header is present. To avoid this issue, either omit the Content-Type header entirely or include an empty JSON object {} in the request body.
\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}},"urlObject":{"path":["supplier-orders",":internal_order_number","cancel"],"host":["{{api_url}}"],"query":[],"variable":[{"id":"11ba2f41-fa3b-4a7f-8322-76155bbbbffe","type":"any","value":"","key":"internal_order_number"}]}},"response":[{"id":"67298951-ec97-4d2d-9d01-a8d855c11b5e","name":"Ok","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{api_url}}/supplier-orders/:internal_order_number/cancel","host":["{{api_url}}"],"path":["supplier-orders",":internal_order_number","cancel"],"variable":[{"key":"internal_order_number","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"79ce074d-2147-42e2-b5fa-4fea682a32bb"},{"name":"List seller suppliers","id":"9e95c961-1e5a-4a64-9723-287306f81775","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/seller-suppliers","description":"Retrieves a paginated list of suppliers configured for the seller.
\npage (integer, optional) - Page number (default: 0).
per_page (integer, optional) - Items per page (default: 10).
data - Array of supplier objects:
id - Supplier ID (use this as seller_supplier_id when creating orders).
name - Supplier name.
active - Whether the supplier is active.
meta - Pagination information:
page - Current page.
per_page - Records per page.
\n\n🚧 This documentation is under construction
\n
This document describes the public API endpoints for managing supplier orders in the Melonn platform. Supplier orders represent inventory replenishment shipments from suppliers to Melonn warehouses.
\nThe following table describes all possible supplier order states:
\nCreated (1) → Confirmed (2) → Received (6) → Reception In Process (4) → Finalized (5)\n ↓ ↓\nCanceled (3) Canceled (3)\n\nNotes:
\nOrders can only be cancelled when in Created (1) or Confirmed (2) states.
Once packages start arriving at the warehouse, the order moves to Received (6).
During unpacking, the order is in Reception In Process (4).
When all products have been processed, the order becomes Finalized (5).
The following reception services can be requested for line items:
\n","_postman_id":"236fda4c-c34a-4149-8ee7-614dc95dc4e4","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}}},{"name":"Buyer return orders - V2","item":[{"name":"Create return order","id":"e34164f0-aece-44a6-bebb-6c84daadb3f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"assigned_warehouse_code\": \"WCOD-1\",\n \"buyer_return_order_shipping_method_id\": 1,\n \"external_order_number\": \"test-public-api-001\",\n \"buyer\": {\n \"full_name\": \"Test Test\",\n \"phone_number\": \"+573123456789\",\n \"email\": \"string\"\n },\n \"comments\": \"dummy commet\",\n \"pickup_info\": {\n \"full_name\": \"Test Test\",\n \"identification_number\": \"1000000\",\n \"address_l1\": \"CRA 12 A # 145 A - 22\",\n \"address_l2\": \"\",\n \"city\": \"Bogota\",\n \"region\": \"Cundinamarca\",\n \"country\": \"Colombia\",\n \"postal_code\": \"12\",\n \"phone_number\": \"573123456789\",\n \"pickup_date\": \"2025-01-31\"\n },\n \"line_items\": [\n {\n \"sku\": \"AAABC-2-J0013-L0027-1723-M\",\n \"qty_returned\": 1,\n \"buyer_return_reason_id\": 1,\n \"buyer_return_item_action_id\": 1,\n \"return_comments\": \"test comment\"\n }\n ]\n}\n","options":{"raw":{"language":"json"}}},"url":"{{api_url}}/buyer-return-orders/v2","description":"This API endpoint allows you to create a buyer return order from an existing Melonn order.
\necommerce_store_id (integer, optional) - ID of the e-commerce store, specific to each seller configuration.
external_order_number (string) - External identifier for the return.
external_order_id (integer) - External number identifier for the return.
buyer (object) - Buyer details:
full_name (string) - Buyer's full name.
phone_number (string) - Buyer's phone number, including country code (e.g., +57-3000000000).
email (string) - Buyer's email address.
parent_external_order_number (string) - External identifier of the parent sell order.
comments (string) - Optional comments about the return.
pickup_info (object) - Information about the pickup location if the return needs to be collected.
full_name (string) - Name of the person handing over the return.
identification_number (string) - Identification number of the person handing over the return.
address_l1 (string) - Pickup address line 1.
address_l2 (string) - Additional address details (optional).
city (string) - Pickup city.
region (string) - Pickup region or state.
country (string) - Pickup country.
postal_code (string) - Postal code (optional).
phone_number (string) - Phone number, including country code.
pickup_date (string) - Date for the pickup (UTC-0).
line_items (array) - List of returned items.
sku (string) - SKU of the product.
qty_returned (integer) - Quantity being returned.
buyer_return_reason_code (integer) - Reason for return (refer to the Reason Table below).
buyer_return_item_action_code (integer) - Action to take for the returned item (refer to the Actions Table below).
buyer_return_order_shipping_method_code (integer) - Shipping method code, indicating whether Melonn or the buyer handles transportation.
{\n \"parent_external_order_number\": \"EXT-123\",\n \"buyer_return_order_shipping_method_code\": 1,\n \"external_order_number\": \"test-public-api-001\",\n \"external_order_id\": 1,\n \"buyer\": {\n \"full_name\": \"Test Test\",\n \"phone_number\": \"+573123456789\",\n \"email\": \"string\"\n },\n \"comments\": \"dummy commet\",\n \"pickup_info\": {\n \"full_name\": \"Test Test\",\n \"identification_number\": \"1000000\",\n \"address_l1\": \"CRA 12 A # 145 A - 22\",\n \"address_l2\": \"\",\n \"city\": \"Bogota\",\n \"region\": \"Cundinamarca\",\n \"country\": \"Colombia\",\n \"postal_code\": \"12\",\n \"phone_number\": \"573123456789\",\n \"pickup_date\": \"2025-01-31\"\n },\n \"line_items\": [\n {\n \"sku\": \"AAABC-2-J0013-L0027-1723-M\",\n \"qty_returned\": 1,\n \"buyer_return_reason_code\": 1,\n \"buyer_return_item_action_code\": 1,\n \"return_comments\": \"test comment\"\n }\n ]\n}\n\nRetrieves the details of a specific return order.
\nThe response will contain the details of the buyer return order, including various attributes such as ID, internal and external order numbers, seller and buyer information, order state, dates.
\nid: Internal ID of the buyer return order.
internal_order_number: Internal return order number.
external_order_number / external_order_id: Identifiers used by external systems.
assigned_warehouse_code: Code of the warehouse where the return is processed.
buyer_full_name: Full name of the buyer that generated the return.
creation_date: Date and time when the return order was created.
last_modified_date: Date and time of the last update to the return order.
return_full_label_url: A download URL valid for 3 days.
buyer_return_order_state: Object with detailed information about the state of the return order, including:
code, closed, description.line_items_summary: Array with the summary of the returned products.
Each item in this array includes:
sku: SKU of the returned product.
qty_returned: Quantity of that SKU that was returned.
qty_received_ok: (Optional) Quantity of items received in good condition.
qty_received_ok_restocked: (Optional) Quantity of items received in good condition that were restocked.
qty_received_ok_not_restocked: (Optional) Quantity of items received in good condition that were not restocked.
qty_received_defective: (Optional) Quantity of items received in defective condition.
composite: Indicates whether the product is a composite (kit) or not.
content: (Optional) If the product is composite and has components, this field lists its atomic components; otherwise, it is undefined. Each component in the content array includes:
sku: SKU of the component product.
qty_returned: Quantity of that component SKU that was returned.
qty_received_ok: (Optional) Quantity of component items received in good condition.
qty_received_ok_restocked: (Optional) Quantity of component items received in good condition that were restocked.
qty_received_ok_not_restocked: (Optional) Quantity of component items received in good condition that were not restocked.
qty_received_defective: (Optional) Quantity of component items received in defective condition.
parent_sell_order: Sell order that the return was created from.
This response will contain line_items_summary, which includes all the information about the returned products. If a product is a composite (kit), its atomic components will be listed in the content field of the composite product.
The fields qty_received_ok, qty_received_ok_restocked, qty_received_ok_not_restocked, and qty_received_defective are only present when the return order has been received and unpacked at the warehouse. These fields provide detailed information about the condition and handling of the returned items.
Example:
\n{\n \"id\": 76409,\n \"internal_order_number\": \"R76409\",\n \"external_order_number\": \"12600005422400-DEVOLUCION\",\n \"external_order_id\": null,\n \"assigned_warehouse_code\": \"WCOD-2\",\n \"buyer_full_name\": \"Test Test\",\n \"creation_date\": \"2025-11-12T00:44:25.000Z\",\n \"last_modified_date\": \"2025-11-20T20:15:44.000Z\",\n \"return_full_label_url\": \"https://buyer-return-orders-resources-335198790816.s3.us-east-1.amazonaws.com/public/warehouses/5/return-orders/melonn-full-labels/2025-11-12/R76409-melonn-full-label.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAU4C3HUSQMIBO33TH/20251126/us-east-1/s3/aws4_request&X-Amz-Date=20251126T182028Z&X-Amz-Expires=3600&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEML//////////wEaCXVzLWVhc3QtMSJHMEUCIQD3yLCN+zCuysdAgMQWq9VrT8JDl13WyBCWlF8bMa/1mAIgGrTFxKpznbv3PJYGBholqHrKCeYtbObJs6nO3GNpiv8qsAMIi///////////ARACGgwzMzUxOTg3OTA4MTYiDHKtqESh48vtEFM63iqEA9ncezV1qBHlPI8ZIRCZ4ITFgRJLPrvl64QADF899GcEdizYmOm4zx8niEabttDtMXgNQn9nJf0mH7eKQ8muP6SF7utBcJqO29wwe0nLe/spY6TheNdz0Er9tpKhOd2UZGyXoGG0ZOB6PN9puLSm+h2lcdq+oUXFRzFmBmk4JxKiEn0NErumPoBaFVtyHfRUqNK8/6Niqnd3VJWFovVJEERYwE0dXqmC/owGwvLc5srPBrylV7fte4qgkBE6ERjwwW+ktsrQwvvqLU7NPbCpa0xFJk2u7cDWKMQZyUU9BIWO10kcr2RC8UJmlxmrL4POePERH7L4VjHyUiIIx/YGNmadZta2Kf0CKtnEYTMGN5MQbHMNXJ4fmYvvYBWif5+L7qkSbHn1ZiqBpaUPtwGSrVbf2Fd9aurdk6fUe/cYiN+U6ZJ42UnktLHyTo9fsPg8GDTxodbWUSNzt6r3UeubULcNGmAjgsqDqQ/qCEB7yqEozsjm1lSiRu2g0ni3GLrzKcd0y7kws/KcyQY6nQG1UcltftSbfovPNGytnJ5u1ewkbNJ+/KjwhXbpFEe/d38guODzXqeAA4F4ySSClu6enQoTLax8O0UUxpmVsVickcFomwbV6PpYP2DFbR7xemN0CLASz0ruA/RIAx3fuWzVUjInSqdR5MOFXiXCYmIS+36bmm7vU3cLZNBd81y+3x8NbppNbwcS1J4zgQBKVTQcKV3pOJM53kJSHrvJ&X-Amz-Signature=14278023e37fcfbc0f6f32a66e968a8e083ff5809a0bdbf76dfb5bbe9974476c&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\",\n \"buyer_return_order_state\": {\n \"code\": 6,\n \"closed\": true,\n \"description\": \"Processed\"\n },\n \"line_items_summary\": [\n {\n \"sku\": \"BLACK_SHIRT_SIZE_M\",\n \"qty_returned\": 1,\n \"qty_received_ok\": 1,\n \"qty_received_ok_restocked\": 1,\n \"qty_received_ok_not_restocked\": 0,\n \"qty_received_defective\": 0,\n \"composite\": false\n },\n {\n \"sku\": \"SHIRT_KIT_SIZE_M\",\n \"qty_returned\": 1,\n \"qty_received_ok\": 1,\n \"qty_received_ok_restocked\": 0,\n \"qty_received_ok_not_restocked\": 1,\n \"qty_received_defective\": 0,\n \"content\": [\n {\n \"sku\": \"BLACK_SHIRT_SIZE_M\",\n \"qty_returned\": 1,\n \"qty_received_ok\": 1,\n \"qty_received_ok_restocked\": 1,\n \"qty_received_ok_not_restocked\": 0,\n \"qty_received_defective\": 0\n },\n {\n \"sku\": \"RED_SHIRT_SIZE_M\",\n \"qty_returned\": 1,\n \"qty_received_ok\": 1,\n \"qty_received_ok_restocked\": 0,\n \"qty_received_ok_not_restocked\": 1,\n \"qty_received_defective\": 0\n },\n {\n \"sku\": \"GREEN_SHIRT_SIZE_M\",\n \"qty_returned\": 1,\n \"qty_received_ok\": 0,\n \"qty_received_ok_restocked\": 0,\n \"qty_received_ok_not_restocked\": 0,\n \"qty_received_defective\": 1\n }\n ],\n \"composite\": true\n }\n ],\n \"parent_sell_order\": {\n \"internal_order_number\": \"M1234567890\",\n \"external_order_number\": \"EX1234567890\",\n \"external_order_id\": \"123\"\n }\n}\n\nIn this example:
\nThe first product (sku: BLACK_SHIRT_SIZE_M) is a standard product (not composite) that was received in good condition and restocked.
\nThe second product (sku: SHIRT_KIT_SIZE_M) is a kit product (composite) that consists of three atomic products:
\nBLACK_SHIRT_SIZE_M: received in good condition and restocked
\nRED_SHIRT_SIZE_M: received in good condition but not restocked
\nGREEN_SHIRT_SIZE_M: received in defective condition
\nThe internal ID or external number of the buyer return order.
\n","type":"text/plain"},"type":"any","value":"R00527","key":"id"}]}},"response":[{"id":"5c30e692-e3a5-4b41-90b0-9829007a1726","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/buyer-return-orders/v2/:id","host":["{{api_url}}"],"path":["buyer-return-orders","v2",":id"],"variable":[{"key":"id","value":"R00527"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 01 Dec 2025 16:20:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2178"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"410f3ad7-2c0d-4063-99ae-d278e21cb7da"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"afcc2600-1b9f-417c-8d8d-d48935e08d6a"},{"key":"x-amzn-Remapped-Content-Length","value":"2178"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Mon, 01 Dec 2025 16:20:36 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"U6r9MGauIAMEquQ="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"2178"},{"key":"X-Amzn-Trace-Id","value":"Root=1-692dc054-6b16afd33f9d3f6d71b4143a"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Mon, 01 Dec 2025 16:20:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": 527,\n \"internal_order_number\": \"R00527\",\n \"external_order_number\": \"PAO-D2C-ORDER-WITH-KIT-DEVOLUCION\",\n \"external_order_id\": null,\n \"assigned_warehouse_code\": \"WCOD-2\",\n \"buyer_full_name\": \"Test Test\",\n \"creation_date\": \"2025-12-01T16:16:13.000Z\",\n \"last_modified_date\": \"2025-12-01T16:16:13.000Z\",\n \"return_full_label_url\": \"https://buyer-return-orders-resources-014568175151.s3.us-east-1.amazonaws.com/public/warehouses/2/return-orders/melonn-full-labels/2025-03-26/R00515-melonn-full-label.pdf?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Content-Sha256=UNSIGNED-PAYLOAD&X-Amz-Credential=ASIAQGZCUWYXVP3MDZP4%2F20251201%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20251201T162036Z&X-Amz-Expires=259200&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEDkaCXVzLWVhc3QtMSJHMEUCICHmPhl39zRr9vcEmMzBrPwXETdQmmidl2ZdatLQhFA5AiEA%2FtHuPPEABKwxBx42Kon0UPMUrYMfHskggio3d%2FWEZiIqoQMIARAAGgwwMTQ1NjgxNzUxNTEiDM8i8zjVddz6fUvrFir%2BAu7N1xMHefS8c5vE40QEY%2F7ih691jY90m44RbctXTU8jrY0c0U5mg%2BA68kM4h3LwqYQRUrvLIfWetd6DsQDk75iihnloTx8lu2HpEpeE3%2B1GNlw8gXyjK3KdM7uTiz99DweRjBhsS8PnHQdtqku08RY7N0wDKQ01KjbLYhWhPXp2toQn%2BG36n1kBhOz3oRkDm1G0UK9P0RkKGdUU40wTDo6RzqYaRkaznBZOIk1vKhCfzRQGQRD2V4LPSqdkryndoSnaVCpTAWSgDs3ZZgMeDwgPFzUC35rCpSf%2B1BcjeT%2ByjeKDpc%2F3Y5kCw2CaLorXcGJpxDthft3CCqG%2B4obd5eztoMnXN52AoTBq7nBNnkZCYd5Am%2F%2BXAEsZ4eI4Yi5O%2BvrvjUuNUB9aQQLartHzo045MOAUVO4BRLfr95XwgBZuoQ1UQegtvEZEYU8jY6Ktz2kc7suumfgfDxV4bFHyPLOcX1PJ5xU4EqATMizPqjZoU3%2B1PQhMf88ir%2BfykiQwuf%2B2yQY6nQEiw3hidedV2L%2FBBmeRu%2BkNO5g9vzWUZ0h50kTnSfGz4hMN1StawLzY3h5JXR1LfXSF82UnBVHkbbK8hk3C43nePF6v8QwOzT3Ye5jVwMDwf7BHCPkrO6nIT0vZQ0mZt7GE94lOMEuokXy%2BEOgx23OWBHIY0ihDT0fCZY0u9%2FngbscqentFgnQ%2FI6GPr5zAw4SypGXV18zEDSOcP7Xv&X-Amz-Signature=4db60558f300d24a2847863c6744cc733de6ac0a9d383d97e6e901f7737fc8f6&X-Amz-SignedHeaders=host&x-amz-checksum-mode=ENABLED&x-id=GetObject\",\n \"buyer_return_order_state\": {\n \"code\": 1,\n \"closed\": false,\n \"description\": \"Created\"\n },\n \"line_items_summary\": [\n {\n \"sku\": \"S0001\",\n \"qty_returned\": 2,\n \"content\": [],\n \"composite\": false\n },\n {\n \"sku\": \"S0003\",\n \"qty_returned\": 2,\n \"content\": [],\n \"composite\": false\n },\n {\n \"sku\": \"S0004\",\n \"qty_returned\": 2,\n \"content\": [],\n \"composite\": false\n }\n ],\n ,\n \"parent_sell_order\": {\n \"internal_order_number\": \"M1234567890\",\n \"external_order_number\": \"EX1234567890\",\n \"external_order_id\": \"123\"\n }\n}"}],"_postman_id":"7042b472-0ebd-4e64-a1b4-51a5d53afb66"},{"name":"List return orders","id":"db4b8bfb-2157-4236-a7cc-c7772083b89c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/buyer-return-orders/v2/?page=0&per_page=10","description":"Query Parameters
\npage (integer, optional): Page number (default 0).
per_page (integer, optional): Items per page (max 100).
buyer_return_order_state_id[] (array[int], optional): Filter by one or multiple status IDs (e.g., ?buyer_return_order_state_code=[1,2,3]).
external_order_number[] (array[string], optional): Filter by one or multiple external order ids (e.g., ?external_order_number=[\"11233\", \"342342\"]).
On success, the endpoint returns a JSON object with two main sections: data and meta.
data is an array where each element represents a buyer return order.
Each buyer return order includes, among others, the following attributes:
id: Internal ID of the buyer return order.
internal_order_number: Internal return order number.
external_order_number / external_order_id: Identifiers used by external systems.
assigned_warehouse_code: Code of the warehouse where the return is processed.
buyer_full_name: Full name of the buyer that generated the return.
creation_date: Date and time when the return order was created.
last_modified_date: Date and time of the last update to the return order.
buyer_return_order_state: Object with detailed information about the state of the return order, including:
code, closed, description.meta contains pagination information:
page: Current page number.
per_page: Maximum number of records returned per page.
Page number
\n","type":"text/plain"},"key":"page","value":"0"},{"description":{"content":"Items per page (max 100)
\n","type":"text/plain"},"key":"per_page","value":"10"},{"disabled":true,"description":{"content":"Filter by one or multiple status IDs
\n","type":"text/plain"},"key":"buyer_return_order_state_code","value":"[1,2,3]"},{"disabled":true,"description":{"content":"Filter by one or multiple external order ids
\n","type":"text/plain"},"key":"external_order_number","value":"[\"11233\", \"342342\"]"}],"variable":[]}},"response":[{"id":"5fbf52bd-460f-41ff-9276-e7c56c841460","name":"Ok","originalRequest":{"method":"GET","header":[],"url":{"raw":"{{api_url}}/buyer-return-orders/v2/?page=0&per_page=10","host":["{{api_url}}"],"path":["buyer-return-orders","v2",""],"query":[{"key":"page","value":"0"},{"key":"per_page","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 01 Dec 2025 16:20:36 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"2178"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"410f3ad7-2c0d-4063-99ae-d278e21cb7da"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"afcc2600-1b9f-417c-8d8d-d48935e08d6a"},{"key":"x-amzn-Remapped-Content-Length","value":"2178"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Mon, 01 Dec 2025 16:20:36 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"U6r9MGauIAMEquQ="},{"key":"x-amzn-Remapped-x-amzn-Remapped-content-length","value":"2178"},{"key":"X-Amzn-Trace-Id","value":"Root=1-692dc054-6b16afd33f9d3f6d71b4143a"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Mon, 01 Dec 2025 16:20:36 GMT"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"id\": 76409,\n \"internal_order_number\": \"R76409\",\n \"external_order_number\": \"12600005422400-DEVOLUCION\",\n \"external_order_id\": null,\n \"assigned_warehouse_code\": \"WCOD-1\",\n \"buyer_full_name\": \"Aldo Alonso Carrete Espinoza\",\n \"creation_date\": \"2025-11-12T00:44:25.000Z\",\n \"last_modified_date\": \"2025-11-20T20:15:44.000Z\",\n \"buyer_return_order_state\": {\n \"code\": 6,\n \"closed\": true,\n \"description\": \"Processed\"\n }\n }\n ],\n \"meta\": {\n \"page\": 1,\n \"per_page\": 10\n }\n}"}],"_postman_id":"db4b8bfb-2157-4236-a7cc-c7772083b89c"},{"name":"Cancel return order","id":"f49a2fd0-1c9d-48d7-a472-7db8e4c257ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"{{api_url}}/buyer-return-orders/v2/:internal_order_number/cancel","description":"Cancel a return order. This action is only valid if the return order is in one of the following statuses:
\nThe internal ID of the buyer return order.
\n","type":"text/plain"},"type":"any","value":"R00527","key":"internal_order_number"}]}},"response":[{"id":"ed4f4a42-e699-4c67-ac4e-e325d87f2902","name":"Ok","originalRequest":{"method":"POST","header":[],"url":{"raw":"{{api_url}}/buyer-return-orders/v2/:internal_order_number/cancel","host":["{{api_url}}"],"path":["buyer-return-orders","v2",":internal_order_number","cancel"],"variable":[{"key":"internal_order_number","value":"R00527","description":"The internal ID of the buyer return order."}]}},"status":"No Content","code":204,"_postman_previewlanguage":null,"header":[{"key":"Date","value":"Mon, 01 Dec 2025 16:41:54 GMT"},{"key":"Content-Type","value":"application/json"},{"key":"Content-Length","value":"0"},{"key":"Connection","value":"keep-alive"},{"key":"x-amzn-RequestId","value":"efdaea13-1ae3-4bae-9226-36918de65dc5"},{"key":"x-amzn-Remapped-x-amzn-RequestId","value":"1fa2062f-db25-45e8-b5cb-a4b890985e75"},{"key":"x-amzn-Remapped-Content-Length","value":"0"},{"key":"x-amzn-Remapped-x-amzn-Remapped-date","value":"Mon, 01 Dec 2025 16:41:54 GMT"},{"key":"x-amzn-Remapped-Connection","value":"keep-alive"},{"key":"x-amz-apigw-id","value":"U6vERG4jIAMErZg="},{"key":"X-Amzn-Trace-Id","value":"Root=1-692dc54e-0ac3e8fb1d6786397fefd835"},{"key":"x-amzn-Remapped-x-amzn-Remapped-connection","value":"keep-alive"},{"key":"x-amzn-Remapped-Date","value":"Mon, 01 Dec 2025 16:41:54 GMT"}],"cookie":[],"responseTime":null,"body":null}],"_postman_id":"f49a2fd0-1c9d-48d7-a472-7db8e4c257ed"}],"id":"20078787-3bb0-41a2-8461-2cd442a6d932","description":"\n\n🚧 This documentation is under construction, if you need to find more information you can check it out at learn with Melonn - Buyer return orders
\n
A Buyer Return Order represents the process of managing returns for items purchased by a customer. This API allows you to create, cancel, list, and retrieve return orders, offering the flexibility needed to handle customer returns efficiently and reliably.
\nReturn Items: Details the items being returned, including quantities, reasons, and actions to be taken.
\nOrder States: Tracks the status of the return order, from creation to processing or closure.
\nProduct Kit: A kit product is a composition of multiple atomic products. It has all the properties of a product (barcode, SKU, etc.), but physically consists of multiple atomic products.
\nAtomic Product: An atomic product is a single item and the fundamental entity that Melonn operates with.
\nThis table show the states a buyer return order could have. The states with the closed flag on true represents the end of lifecycle.
\n\n\n🚧 This documentation is under construction .-----------------------------------------------------
\n
This documentation will allow you to create, update, list and obtain Seller Products using their respective API.
\nSeller Product
\n","_postman_id":"6b354f0e-79c4-4ec6-888b-b7e00cc293f1","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}}},{"name":"Stock","item":[{"name":"Get available stock","id":"d9d32baa-58ae-4176-8159-53c3c1b3e859","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"{{api_url}}/stock?warehouse_code=BOG-2","description":"Retrieves the available stock quantities for products in a specific warehouse.
\nwarehouse_code (string, required) - The unique code identifying the destination warehouse.
sku (array[string], optional) - Filter by specific SKU codes (e.g., ?sku=[SKU-001,SKU-002]).
page (integer, optional) - Page number for pagination (min: 1).
per_page (integer, optional) - Number of results per page (min: 1, max: 100).
The response contains two sections: data and meta_data.
data - Array of stock items. Each item includes:
sku - The product SKU code.
qty_available - The quantity available for sale/fulfillment in the specified warehouse.
meta_data - Pagination information:
page - Current page number.
per_page - Number of records per page.
Retrieves a paginated list of historical stock adjustment records for the authenticated seller.
\nstart_date (datetime, optional) - Filter adjustments from this date (ISO 8601 format, e.g., 2024-01-01T00:00:00.000Z). Defaults to 1 year ago from the current date. Dates older than 1 year will be adjusted to the 1-year limit.
end_date (datetime, optional) - Filter adjustments up to this date (ISO 8601 format, e.g., 2024-12-31T23:59:59.000Z). Defaults to the current date.
sku (string, optional) - Filter by a specific SKU code.
page (integer, optional) - Page number for pagination (default: 0, min: 0).
per_page (integer, optional) - Number of results per page (default: 10, min: 1, max: 100).
The response contains two sections: data and meta_data.
data - Array of stock adjustments. Each adjustment includes:
internal_adjustment_identifier - Unique internal identifier for the adjustment.
adjustment_date - Date and time when the adjustment was executed (ISO 8601 format).
adjustment_details - Array of adjustment detail items. Each detail includes:
sku - The product SKU code.
quantity_adjusted - The quantity changed (positive for additions, negative for reductions).
adjustment_justification - Justification information:
name - Name of the justification type.
description - Detailed description of the justification (may be null).
meta_data - Pagination information:
page - Current page number.
per_page - Number of records per page.
quantity_adjusted can be positive (stock increase) or negative (stock decrease).
\nAdjustments are grouped by internal_adjustment_identifier.
\nThe maximum queryable date range is 1 year from the current date.
\nIf start_date is not provided or is older than 1 year, it defaults to 1 year ago.
\n\n\n🚧 This documentation is under construction
\n
This document describes the public API endpoints for managing stock information in the Melonn platform. The Stock Public API allows sellers to query their available inventory and view historical stock adjustments at Melonn warehouses.
\n","_postman_id":"3686af81-eb42-4a94-a4c5-ab066e23039e","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]},"isInherited":true,"source":{"_postman_id":"e5baeb02-7809-432c-bbed-66b8b2504325","id":"e5baeb02-7809-432c-bbed-66b8b2504325","name":"Melonn sellers API","type":"collection"}}},{"name":"Webhooks","item":[],"id":"4892ec31-9212-4aec-bd44-e6f5cb8f62a4","description":"In the Webhooks section, you can enable and manage all the events you want to receive on your custom URL associated with your user.
\nEvery time an event is triggered, our system will send an HTTP notification (POST request) to the configured URL, including a JSON payload with the relevant event information in the message body.
\nBelow are configuration examples for each new webhook, along with examples of the input data (request body) you will receive on your endpoint upon notification.
\nAdditionally, after configuring a webhook, you can test it from the configured webbooks system.
\nWe will send a test event to the URL you configured.
\n{\n \"eventDate\": \"2025-09-30T20:45:28.961Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/CANCELED\"\n },\n \"eventData\": {\n \"id\": 9999999999999999,\n \"externalOrderId\": \"\",\n \"internalOrderNumber\": \"M9999999999999999\",\n \"externalOrderNumber\": \"20250930204137099\",\n \"sellOrderState\": {\n \"id\": 15,\n \"name\": \"Canceled\"\n },\n \"warehouse\": {\n \"id\": 1,\n \"name\": \"Test Warehouse\"\n },\n \"seller\": {\n \"id\": 123,\n \"name\": \"Demo Store\"\n },\n \"shippingMethod\": {\n \"id\": 10,\n \"name\": \"Standard Test Shipping\"\n },\n \"fulfillmentType\": {\n \"id\": 3,\n \"deliveryMode\": \"DELIVERY\"\n },\n \"shippingType\": {\n \"id\": 1,\n \"name\": \"Delivery\"\n },\n \"sellOrderLineItems\": [\n {\n \"sellerProductId\": 111111,\n \"productName\": \"Test Product A\",\n \"productVariant\": \"Variant A\",\n \"sellerProductSku\": \"TPA-001\",\n \"sellerProductExternalBarcode\": \"1234567890123\",\n \"sellerProductInternalCode\": \"TEST111111\",\n \"qtyOrdered\": 2,\n \"fulfillable\": true,\n \"qtyReserved\": 0,\n \"qtyToFulfill\": 2,\n \"productTypeId\": 1\n },\n {\n \"sellerProductId\": 222222,\n \"productName\": \"Test Product B\",\n \"productVariant\": \"Variant B\",\n \"sellerProductSku\": \"TPB-002\",\n \"sellerProductExternalBarcode\": \"9876543210987\",\n \"sellerProductInternalCode\": \"TEST222222\",\n \"qtyOrdered\": 1,\n \"fulfillable\": true,\n \"qtyReserved\": 0,\n \"qtyToFulfill\": 1,\n \"productTypeId\": 1\n }\n ],\n \"buyerFullName\": \"John Doe\",\n \"buyerPhoneNumber\": \"+57-3000000000\",\n \"buyerEmail\": \"john.doe@example.com\"\n }\n}\n\n{\n \"eventDate\": \"2025-09-30T20:45:28.961Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/DELIVERED_TO_BUYER\",\n \"tags\": [\n \"test\",\n \"demo\"\n ]\n },\n \"eventData\": {\n \"internalOrderNumber\": \"MTEST123456789\",\n \"buyerFullName\": \"Alice Johnson\",\n \"buyerEmail\": \"alice.johnson@example.com\",\n \"buyerPhoneNumber\": \"+57-3111111111\",\n \"externalOrderNumber\": \"EXT-20250930-0001\",\n \"externalOrderId\": \"EXT123456\",\n \"id\": 987654321,\n \"sellOrderState\": {\n \"id\": 1,\n \"name\": \"Delivered\"\n },\n \"warehouse\": {\n \"id\": 10,\n \"name\": \"Test Warehouse Bogotá\"\n },\n \"seller\": {\n \"id\": 200,\n \"name\": \"Demo Seller Store\"\n },\n \"sellerEcommerceStore\": {\n \"id\": 300,\n \"name\": \"Demo Shopify Store\",\n \"storeIdentifier\": \"shopify-12345\"\n },\n \"ecommercePlatform\": {\n \"id\": 1,\n \"name\": \"Shopify\"\n },\n \"shippingMethod\": {\n \"id\": 55,\n \"name\": \"Express Test Shipping\"\n },\n \"fulfillmentType\": {\n \"id\": 3,\n \"deliveryMode\": \"DELIVERY\"\n },\n \"sellOrderLineItems\": [\n {\n \"sellerProductId\": 1001,\n \"productName\": \"Test Sneakers\",\n \"productVariant\": \"Blue - Size 42\",\n \"sellerProductSku\": \"TSNK-B42\",\n \"sellerProductExternalBarcode\": \"1234567890123\",\n \"sellerProductInternalCode\": \"P1001\",\n \"qtyOrdered\": 1,\n \"serialNumbers\": [\n \"SN123456789\"\n ],\n \"fulfillable\": true,\n \"qtyReserved\": 0,\n \"qtyToFulfill\": 1,\n \"productTypeId\": 1\n },\n {\n \"sellerProductId\": 1002,\n \"productName\": \"Test T-Shirt\",\n \"productVariant\": \"Red - L\",\n \"sellerProductSku\": \"TTRED-L\",\n \"sellerProductExternalBarcode\": \"9876543210987\",\n \"sellerProductInternalCode\": \"P1002\",\n \"qtyOrdered\": 2,\n \"serialNumbers\": [],\n \"fulfillable\": true,\n \"qtyReserved\": 0,\n \"qtyToFulfill\": 2,\n \"productTypeId\": 1\n }\n ],\n \"sellOrderAttempt\": [\n {\n \"id\": 1,\n \"current\": true,\n \"deliveryService\": [\n {\n \"id\": 101,\n \"trackingNumber\": \"TRACK12345\"\n }\n ],\n \"deliveryRoute\": {\n \"id\": 500,\n \"internalRouteNumber\": \"RTE-0001\",\n \"transportService\": {\n \"id\": 900,\n \"name\": \"Fast Courier Service\",\n \"courierCompany\": {\n \"id\": 50,\n \"name\": \"Demo Courier Co.\"\n },\n \"transportServiceType\": {\n \"id\": 5,\n \"name\": \"Ground\"\n }\n }\n }\n }\n ]\n }\n}\n\n{\n \"eventDate\": \"2023-08-28T15:57:54.020Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/ITEMS_RESERVED\"\n },\n \"eventData\": {\n \"id\": 213217314323232,\n \"internalOrderNumber\": \"M213217314323232\",\n \"externalOrderNumber\": \"\",\n \"sellOrderState\": {\n \"id\": 2,\n \"name\": \"All items reserved - ready for fulfillment\"\n },\n \"warehouse\": {\n \"id\": 2,\n \"name\": \"Medellin #1\"\n },\n \"seller\": {\n \"id\": 1,\n \"name\": \"My seller\"\n },\n \"buyerFullName\": \"Pepito perez\",\n \"buyerPhoneNumber\": \"+57-3000000000\",\n \"shippingMethod\": {\n \"id\": 6,\n \"name\": \"Recogida\"\n },\n \"shippingType\": {\n \"id\": 2,\n \"name\": \"Pickup at Melonn\"\n },\n \"promises\": {\n \"shipPromiseMax\": \"2023-08-28T15:57:39.000Z\",\n \"deliveryPromiseMax\": \"2023-08-28T15:57:39.000Z\"\n },\n \"sellOrderLineItems\": [\n {\n \"sellerProductId\": 1029,\n \"productName\": \"Gafas persianas\",\n \"productVariant\": \"Verde neon\",\n \"sellerProductSku\": \"gafas-persianas-verde\",\n \"sellerProductInternalCode\": \"P00024384\",\n \"qtyOrdered\": 1,\n \"productTypeId\": 1\n }\n ]\n }\n}\n\n{\n \"eventDate\": \"2025-10-01T15:00:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/PICKED_UP_BY_BUYER\",\n \"tags\": [\n \"fake\",\n \"demo\",\n \"test\"\n ]\n },\n \"eventData\": {\n \"internalOrderNumber\": \"MTEST987654321\",\n \"buyerFullName\": \"Carlos Ramírez\",\n \"buyerEmail\": \"carlos.ramirez@example.com\",\n \"externalOrderNumber\": \"EXT-20251001-0001\",\n \"externalOrderId\": \"EXT987654\",\n \"id\": 987654321,\n \"sellOrderState\": {\n \"id\": 5,\n \"name\": \"Packed\"\n },\n \"tags\": [\n \"pickup\",\n \"demo\"\n ],\n \"warehouse\": {\n \"id\": 99,\n \"name\": \"Fake Warehouse #99\"\n },\n \"seller\": {\n \"id\": 555,\n \"name\": \"Demo Seller Store\"\n },\n \"sellerEcommerceStore\": {\n \"storeIdentifier\": \"fake-shop-123\"\n },\n \"ecommercePlatform\": {\n \"id\": 10,\n \"name\": \"FakeCommerce\"\n },\n \"shippingMethod\": {\n \"id\": 77,\n \"name\": \"Recogida Test\"\n },\n \"fulFillmentType\": {\n \"id\": 1,\n \"deliverMode\": \"PICKUP\"\n },\n \"sellOrderLineItems\": [\n {\n \"sellerProductId\": 2001,\n \"productTypeId\": 1,\n \"productName\": \"Fake Sneakers\",\n \"productVariant\": \"Negro - 42\",\n \"sellerProductSku\": \"FSNK42\",\n \"sellerProductExternalBarcode\": \"1111111111111\",\n \"sellerProductInternalCode\": \"PF2001\",\n \"qtyOrdered\": 2,\n \"qtyToFulfill\": 2,\n \"serialNumbers\": []\n },\n {\n \"sellerProductId\": 2002,\n \"productTypeId\": 1,\n \"productName\": \"Fake T-Shirt\",\n \"productVariant\": \"Azul - L\",\n \"sellerProductSku\": \"FTS-AL\",\n \"sellerProductExternalBarcode\": \"2222222222222\",\n \"sellerProductInternalCode\": \"PF2002\",\n \"qtyOrdered\": 1,\n \"qtyToFulfill\": 1,\n \"serialNumbers\": []\n },\n {\n \"sellerProductId\": 2003,\n \"productTypeId\": 1,\n \"productName\": \"Fake Jacket\",\n \"productVariant\": \"Rojo - M\",\n \"sellerProductSku\": \"FJK-RM\",\n \"sellerProductExternalBarcode\": \"3333333333333\",\n \"sellerProductInternalCode\": \"PF2003\",\n \"qtyOrdered\": 1,\n \"qtyToFulfill\": 1,\n \"serialNumbers\": []\n }\n ]\n }\n}\n\n{\n \"eventDate\": \"2025-10-01T14:30:00Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/RECEIVED_VALID\"\n },\n \"eventData\": {\n \"id\": 123456,\n \"buyerEmail\": \"juan.perez@example.com\",\n \"buyerFullName\": \"Juan Pérez\",\n \"buyerPhoneNumber\": \"+57 3000000000\",\n \"externalOrderNumber\": \"ORD-2025-0001\",\n \"externalOrderId\": \"EXT-98765\",\n \"internalOrderNumber\": \"INT-54321\",\n \"seller\": {\n \"id\": 77,\n \"name\": \"Super Tienda Online\"\n },\n \"sellOrderState\": {\n \"id\": 1,\n \"name\": \"Received - valid\"\n },\n \"warehouse\": {\n \"id\": 1,\n \"name\": \"Bodega Principal\"\n },\n \"shippingMethod\": {\n \"id\": 10,\n \"name\": \"Envío Express\"\n },\n \"sellOrderLineItems\": [\n {\n \"id\": 1001,\n \"productId\": \"SKU-12345\",\n \"productName\": \"Zapatos Deportivos\",\n \"quantity\": 2,\n \"price\": 120000,\n \"currency\": \"COP\"\n },\n {\n \"id\": 1002,\n \"productId\": \"SKU-98765\",\n \"productName\": \"Camiseta Negra\",\n \"quantity\": 1,\n \"price\": 35000,\n \"currency\": \"COP\"\n }\n ],\n \"fulfillmentType\": {\n \"id\": 3,\n \"delivery_mode\": \"HOME_DELIVERY\",\n \"order_type\": \"B2C\",\n \"shipment_type\": \"STANDARD\"\n },\n \"ecommercePlatform\": {\n \"id\": 1,\n \"name\": \"Shopify\"\n },\n \"sellerEcommerceStore\": {\n \"id\": 88,\n \"name\": \"Tienda Oficial SuperTienda\",\n \"storeIdentifier\": \"shopify-store-001\"\n }\n }\n}\n\n{\n \"eventDate\": \"2025-10-01T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"SELL_ORDER\",\n \"type\": \"SELL_ORDER/SHIPPED\",\n \"tags\": [\n \"fake\",\n \"demo\"\n ]\n },\n \"eventData\": {\n \"timestamp\": \"2025-10-01T16:25:00.000Z\",\n \"internalOrderNumber\": \"MTEST1122334455\",\n \"buyerFullName\": \"Laura Fernández\",\n \"buyerEmail\": \"laura.fernandez@example.com\",\n \"buyerPhoneNumber\": \"+57-3100000000\",\n \"externalOrderNumber\": \"EXT-20251001-0002\",\n \"externalOrderId\": \"EXT445566\",\n \"paymentOnDeliveryAmount\": null,\n \"id\": 1122334455,\n \"sellOrderState\": {\n \"id\": 7,\n \"name\": \"Shipped - in transit\"\n },\n \"tags\": [\n \"shipment\",\n \"demo\"\n ],\n \"warehouse\": {\n \"id\": 88,\n \"name\": \"Fake Warehouse Cali\"\n },\n \"seller\": {\n \"id\": 777,\n \"name\": \"Demo Seller Store\"\n },\n \"sellerEcommerceStore\": {\n \"storeIdentifier\": \"fake-store-001\"\n },\n \"ecommercePlatform\": {\n \"id\": 20,\n \"name\": \"FakeCommerce\"\n },\n \"shippingMethod\": {\n \"id\": 15,\n \"name\": \"Test Express Shipping\"\n },\n \"fulfillmentType\": {\n \"id\": 2,\n \"deliveryMode\": \"DELIVERY\"\n },\n \"sellOrderLineItems\": [\n {\n \"sellerProductId\": 3001,\n \"productName\": \"Fake Shoes\",\n \"productTypeId\": 1,\n \"productVariant\": \"Blanco - 41\",\n \"sellerProductSku\": \"FSH-B41\",\n \"sellerProductExternalBarcode\": \"4444444444444\",\n \"sellerProductInternalCode\": \"PF3001\",\n \"qtyOrdered\": 1,\n \"qtyToFulfill\": 1,\n \"serialNumbers\": [\n \"FSN123456\"\n ]\n },\n {\n \"sellerProductId\": 3002,\n \"productName\": \"Fake Polo Shirt\",\n \"productTypeId\": 1,\n \"productVariant\": \"Verde - M\",\n \"sellerProductSku\": \"FPS-VM\",\n \"sellerProductExternalBarcode\": \"5555555555555\",\n \"sellerProductInternalCode\": \"PF3002\",\n \"qtyOrdered\": 2,\n \"qtyToFulfill\": 2,\n \"serialNumbers\": []\n },\n {\n \"sellerProductId\": 3003,\n \"productName\": \"Fake Jeans\",\n \"productTypeId\": 1,\n \"productVariant\": \"Azul - 32\",\n \"sellerProductSku\": \"FJN-A32\",\n \"sellerProductExternalBarcode\": \"6666666666666\",\n \"sellerProductInternalCode\": \"PF3003\",\n \"qtyOrdered\": 1,\n \"qtyToFulfill\": 1,\n \"serialNumbers\": []\n }\n ],\n \"sellOrderAttempt\": [\n {\n \"id\": 9999,\n \"current\": true,\n \"deliveryService\": [\n {\n \"id\": 8888,\n \"trackingNumber\": \"TRACKFAKE123\"\n }\n ],\n \"deliveryRoute\": {\n \"id\": 7777,\n \"internalRouteNumber\": \"RTE-7777\",\n \"transportService\": {\n \"id\": 123,\n \"name\": \"Fast Fake Transport\",\n \"courierCompany\": {\n \"id\": 55,\n \"name\": \"Fake Courier Co.\"\n }\n }\n }\n }\n ]\n }\n}\n\nTriggered when a new return order is successfully created in Orbita.
\nEvent: BUYER_RETURN_ORDER/CREATED
\n{\n \"eventDate\": \"2025-12-03T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"BUYER_RETURN_ORDER\",\n \"type\": \"BUYER_RETURN_ORDER/CREATED\"\n },\n \"eventData\": {\n \"id\": \"76409\",\n \"internalOrderNumber\": \"R76409\",\n \"externalOrderNumber\": \"12600005422400-DEVOLUCION\",\n \"externalOrderId\": \"EXT-123\"\n }\n}\n\nTriggered when the physical return arrives at the Melonn warehouse.
\nEvent: BUYER_RETURN_ORDER/RECEIVED_AT_WAREHOUSE
\n{\n \"eventDate\": \"2025-12-03T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"BUYER_RETURN_ORDER\",\n \"type\": \"BUYER_RETURN_ORDER/RECEIVED_AT_WAREHOUSE\"\n },\n \"eventData\": {\n \"id\": \"76409\",\n \"internalOrderNumber\": \"R76409\",\n \"externalOrderNumber\": \"12600005422400-DEVOLUCION\",\n \"externalOrderId\": \"EXT-123\",\n \"receptionDate\": \"2025-12-03T16:30:00.000Z\"\n }\n}\n\nTriggered when the shipping label is generated.
Note: The transportServiceRequestLabelUrl is a signed URL valid for 1 day.
Event: BUYER_RETURN_ORDER/ITSR_LABEL_GENERATED
\n{\n \"eventDate\": \"2025-12-03T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"BUYER_RETURN_ORDER\",\n \"type\": \"ITSR_LABEL_GENERATED\",\n \"tags\": [\n \"R76409\"\n ]\n },\n \"eventData\": {\n \"id\": \"76409\",\n \"internalOrderNumber\": \"R76409\",\n \"externalOrderNumber\": \"12600005422400-DEVOLUCION\",\n \"externalOrderId\": \"EXT-123\",\n \"transportServiceRequestLabelUrl\": \"https://s3.aws.com/signed-url...\"\n }\n}\n\nName: Buyer Return Order: Unpacked
Triggered when the return order items have been unpacked and verified at the warehouse.
Note: This event includes detailed information about received quantities (OK, defective, restocked) and item summaries including composite products.
Event: BUYER_RETURN_ORDER/UNPACKED
{\n \"eventDate\": \"2023-08-28T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"BUYER_RETURN_ORDER\",\n \"type\": \"BUYER_RETURN_ORDER/UNPACKED\"\n },\n \"eventData\": {\n \"id\": 1454564547,\n \"internalOrderNumber\": \"R0002359\",\n \"externalOrderNumber\": \"SP-566\",\n \"externalOrderId\": \"EXT-123\"\n }\n}\n\nName: Buyer Return Order: Canceled
Triggered when a return order is canceled.
Event: BUYER_RETURN_ORDER/CANCELED
{\n \"eventDate\": \"2025-12-03T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"BUYER_RETURN_ORDER\",\n \"type\": \"BUYER_RETURN_ORDER/CANCELED\"\n },\n \"eventData\": {\n \"id\": 76409,\n \"internalOrderNumber\": \"R76409\",\n \"externalOrderNumber\": \"12600005422400-DEVOLUCION\",\n \"externalOrderId\": \"EXT-123\"\n }\n}\n\nName: Supplier Order: Created
Triggered when a supplier order is created.
Event: SUPPLIER_ORDER/CREATED
{\n \"eventClassifier\":{\n \"category\":\"SUPPLIER_ORDER\",\n \"type\":\"SUPPLIER_ORDER/CREATED\"\n },\n \"eventData\":{\n \"supplierOrderId\": 1994, \n \"supplierOrderExternalOrderNumber\": \"TEST INTEGRATION\",\n \"supplierOrderInternalOrderNumber\": \"I00001994\"\n }\n}\n\nName: Supplier Order: Cancelled
Triggered when a supplier order is cancelled.
Event: SUPPLIER_ORDER/CANCELLED
{\n \"eventClassifier\":{\n \"category\":\"SUPPLIER_ORDER\",\n \"type\":\"SUPPLIER_ORDER/CANCELLED\"\n },\n \"eventData\":{\n \"supplierOrderId\": 1994, \n \"supplierOrderExternalOrderNumber\": \"TEST INTEGRATION\",\n \"supplierOrderInternalOrderNumber\": \"I00001994\"\n }\n}\n\nName: Supplier Order: Closed
Triggered when a supplier order is closed.
Event: SUPPLIER_ORDER/CLOSED
{\n \"eventClassifier\":{\n \"category\":\"SUPPLIER_ORDER\",\n \"type\":\"SUPPLIER_ORDER/CLOSED\"\n },\n \"eventData\":{\n \"supplierOrderId\": 1994, \n \"supplierOrderExternalOrderNumber\": \"TEST INTEGRATION\",\n \"supplierOrderInternalOrderNumber\": \"I00001994\"\n }\n}\n\nName: Supplier order package unpaked
Triggered when a specific package within the order is unpacked and items are verified
Event: SUPPLIER_ORDER_PACKAGE/UNPACKED
{\n \"eventClassifier\":{\n \"category\":\"SUPPLIER_ORDER_PACKAGE\",\n \"type\":\"SUPPLIER_ORDER_PACKAGE/UNPACKED\"\n },\n \"eventData\":{\n \"supplierOrder\":{\n \"id\": 1994,\n \"internalOrderNumber\": \"I00001994\",\n \"externalOrderNumber\": \"TEST INTEGRATION\"\n }\n }\n}\n\nName: Stock Control Point Executed
Triggered when a stock control point is finalized and executed, including any stock adjustments and missing items reported. qtyAdjustment can be positive (stock increase) or negative (stock decrease).
Event: STOCK_MGMT/STOCK_CONTROL_POINT_EXECUTED
{\n \"eventDate\": \"2023-08-28T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"STOCK_MGMT\",\n \"type\": \"STOCK_MGMT/STOCK_CONTROL_POINT_EXECUTED\"\n },\n \"eventData\": {\n \"id\": 1234,\n \"warehouse\": {\n \"id\": 10\n },\n \"stockAdjustments\": [\n {\n \"sellerProductSku\": \"SKU-001\",\n \"qtyAdjustment\": -5\n }\n ]\n }\n}\n\nName: Stock Count Adjustment Executed
\nTriggered when a stock count adjustment is executed, detailing the adjustment line items with their quantities andinsurance values. qtyAdjustments can be positive (stock increase) or negative (stock decrease).
\nEvent: STOCK_MGMT/STOCK_COUNT_ADJUSTMENT_EXECUTED
\n{\n \"eventDate\": \"2023-08-28T16:30:00.000Z\",\n \"eventClassifier\": {\n \"category\": \"STOCK_MGMT\",\n \"type\": \"STOCK_MGMT/STOCK_COUNT_ADJUSTMENT_EXECUTED\"\n },\n \"eventData\": {\n \"stockCountAdjustmentId\": 1234,\n \"internalNumber\": \"ADJ-2024-001\",\n \"warehouse\": {\n \"id\": 10\n },\n \"adjustmentLineItems\": [\n {\n \"sellerProductSku\": \"SKU-001\",\n \"qtyNetAdjustments\": -3\n }\n ]\n }\n}\n\nChange Type: No-breaking
Summary: Optional parameter fields=sell_order_promises is added to the GET endpoint for sell orders to provide delivery promise information
GET /sell-orders/:external_order_number\n\nNo migration required - The change is completely optional and backward compatible
\nTo get promises: Add ?fields=sell_order_promises to existing query
Without promises:
\nGET /sell-orders/TEST_ORDER_001\n\nWith promises:
\nGET /sell-orders/TEST_ORDER_001?fields=sell_order_promises\n\nAdditional fields in current response:
\n{\n \"sell_order_promise_info\": {\n \"promise_source\": \"melonn_internal\",\n \"external_promise_info\": {\n \"promise_type\": \"DELIVERY\",\n \"promise_value\": {\n \"max\": \"2025-05-20 01:30:00\"\n }\n },\n \"pack_ready_to_sort_promise_min\": \"2025-12-17T08:00:00.000Z\",\n \"pack_ready_to_sort_promise_max\": \"2025-12-17T18:00:00.000Z\"\n },\n \"sell_order_attempt\": [{\n \"current\": true,\n \"ready_to_ship_promise_min\": \"2025-12-17T08:00:00.000Z\",\n \"ready_to_ship_promise_max\": \"2025-12-17T18:00:00.000Z\",\n \"delivery_promise_min\": \"2025-12-20T08:00:00.000Z\",\n \"delivery_promise_max\": \"2025-12-20T18:00:00.000Z\"\n }]\n}\n\nCompatibility/Impact: ✅ 100% backward compatible - Does not affect existing query
\nAvailable fields:
\nsell_order_promise_info: Information about packaging and processing promises
sell_order_attempt: Information about shipping and delivery promises
Recommended usage: Include the parameter only when promise information is needed to optimize performance
\nChange Type: No-breaking
Summary: The following events are added to the list of events for webhook configuration.
\nOrden de venta - Cancelada
\nOrden de venta - Entregada al comprador
\nOrden de venta - Items Reservados
\nOrden de venta - Recogida por el comprador
\nOrden de venta - Recibida válida
\nOrden de venta - En tránsito
\nChange Type: No-breaking
Summary: expose new endpoint for list and cancel buyer return orders
\nGET /buyer-return-orders/v2/\nGET /buyer-return-orders/v2/:internal_order_number\nPOST /buyer-return-orders/v2/:internal_order_number/cancel\n\nChange Type: No-breaking
Summary: The following events are added to the list of events for webhook configuration.
\nBuyer Return Order - Created
\nBuyer Return Order - Received at Warehouse
\nBuyer Return Order - Label Generated
\nChange Type: No-breaking
\nSummary: Added new fields to line_items_summary response to include received quantity information for unpacked return orders
\nGET /return-orders/{internalOrderNumber}\n\nNew Response Fields:
\nqty_received_ok: Quantity of items received in good condition
qty_received_ok_restocked: Quantity of items received in good condition that were restocked
qty_received_ok_not_restocked: Quantity of items received in good condition that were not restocked
qty_received_defective: Quantity of items received in defective condition
For composite products these fields are available inside the content array. The content field is now optional (can be undefined instead of empty array when product is not composite).
Compatibility/Impact: ✅ 100% backward compatible - New fields are optional and only present when return order has been unpacked,
\nChange Type: No-breaking
\nSummary: The following events are added to the list of events for webhook configuration.
\nBuyer Return Order - Canceled
Buyer Return Order - Unpacked
Buyer Return Order - Canceled: Triggered when a return order is canceled. A return order can only be canceled if it is in \"Created\" or \"TransportServiceRequested\" state. Event: BUYER_RETURN_ORDER/CANCELED
Buyer Return Order - Unpacked: Triggered when the return order items have been unpacked and verified at the warehouse.
GET /cle/public-api/supplier-orders/\nGET /cle/public-api/supplier-orders/:internal_order_number\nPOST /cle/public-api/supplier-orders/\nPOST /cle/public-api/supplier-orders/:internal_order_number/cancel\nGET /cle/public-api/seller-suppliers/\n\nCompatibility/Impact: ✅ 100% backward compatible - Does not affect existing query
\nSupplier Order - Created
\nSupplier Order - Cancelled
\nSupplier Order - Closed
\nSupplier Order Package - Unpacked
\nCompatibility/Impact: ✅ 100% backward compatible - Does not affect existing webhook configurations
\n","_postman_id":"a1330761-d947-43cd-967e-e6d08e21c32c","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7659417c-33a7-415e-9fbb-13eaba66fe66","id":"7659417c-33a7-415e-9fbb-13eaba66fe66","name":"Change Log","type":"folder"}}}],"id":"b56f5f00-80a1-4e1e-8714-7a73bdcd0b5b","_postman_id":"b56f5f00-80a1-4e1e-8714-7a73bdcd0b5b","description":"","auth":{"type":"noauth","isInherited":true,"source":{"_postman_id":"7659417c-33a7-415e-9fbb-13eaba66fe66","id":"7659417c-33a7-415e-9fbb-13eaba66fe66","name":"Change Log","type":"folder"}}}],"id":"7659417c-33a7-415e-9fbb-13eaba66fe66","auth":{"type":"noauth","isInherited":false},"event":[{"listen":"prerequest","script":{"id":"61ca8f01-cd78-42c7-883c-00867edaf4f0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"7e0e5e3a-a1d0-4944-972e-d1ef7c76e767","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"7659417c-33a7-415e-9fbb-13eaba66fe66","description":""}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"x-api-key"},{"key":"value","value":"{{api_key}}"}]}},"event":[{"listen":"prerequest","script":{"id":"c133e4f2-bb2b-4159-96ea-79d905389707","type":"text/javascript","requests":{},"exec":[""]}},{"listen":"test","script":{"id":"29284390-7297-4c51-bda8-6f5c5fd46c22","type":"text/javascript","requests":{},"exec":[""]}}],"variable":[{"id":"5e867266-7d38-4974-9d30-9eb727991604","key":"sell_orders_collection_path","value":"sell-orders"},{"id":"31c38408-eaa6-4b2c-8a6c-0028ced1e588","key":"vas_collection_path","value":"vas"},{"id":"deea0426-94ac-445a-b5cf-fcb5d8d3c576","key":"business_collection_path","value":"business"},{"id":"f3842b18-9a01-4fa2-ab00-adb1c793cd56","key":"buyer_return_order_path","value":"buyer-return-orders"},{"id":"e3ca5fae-baae-4a99-8767-e1dc56138109","key":"supplier_orders_path","value":"supplier-orders"},{"id":"e0392a59-fd5d-48a6-bafb-156cd2342075","key":"seller_suppliers_path","value":"seller-suppliers"},{"id":"f32dd95b-68a3-48e1-aafe-af5b5209eca3","key":"stock_path","value":"stock"}]}