Skip to content
platform

API reference

Orders

Services for querying and managing orders.

Store Management

  • GET List Store Orders /partnerOrders/list

    Lists the orders in which your store is the supplier — the ones you received to fulfill —, from newest to oldest, with pagination and filters.

  • GET Get Order Details - Store /partnerOrders/:id

    Returns the full order: values, customer, payments, deliveries with products, and the status history.

  • PUT Update Order Status - Store /partnerOrders/:id

    Moves the order to the next status in the fulfillment flow and saves, along with it, the data that status requires — the order number in your ERP, the invoice (nota fiscal), the tracking code.

  • GET List Items with Lead Time Under Inquiry /partnerOrders/:id/partnerOrderLines

    Lists the products of the order whose delivery lead time is under inquiry and has not yet been filled in. It is the queue of items that depend on you informing the lead time before the order moves on.

  • PUT Update Item Lead Time /partnerOrders/:id/partnerOrderLines

    Reports the preparation lead time for the items left with lead time on request. This submission is what releases the order for payment: once the lead times are answered, the customer is notified that the order is available.

  • PUT Upload Invoice XML - Store /partnerOrders/:id/invoice

    Attaches the XML of the invoice (nota fiscal) to the order. The request body is the file itself, sent as binary content — the raw stream of the bytes of the.xml. It is not multipart/form-data, there is no form field and the XML does not go inside a JSON.

  • POST Send Item Tracking - Store /partnerOrders/:id/complementaryInfo

    Reports, item by item, the status of each product in the order — what has already shipped, what is being prepared, what is pending. This is the tracking the customer sees during fulfillment.

  • GET Get Item Tracking - Store /partnerOrders/:id/complementaryInfo

    Returns the item tracking saved on the order — the active set.

  • DELETE Remove Item Tracking - Store /partnerOrders/:id/complementaryInfo

    Deletes the tracking of the order's items, entirely — all parts, all statuses. The order goes back to having no tracking at all.

Marketplace Management

  • GET List Marketplace Orders /partnerOrders/list/store

    Lists the orders originated in your store — those your customers placed, including those that will be fulfilled by other partners —, from newest to oldest, with pagination and filters.

  • GET Get Order Details - Marketplace /partnerOrders/store/:id

    Returns the full details of an order originated in your store: values, customer, payments, deliveries with products, and the status history.

  • GET List Child Orders by Parent Order /partnerOrders/store/order/:id

    Lists the partner orders that originated from the same customer order. An order with items from different suppliers is split into one partner order per supplier, and that split is what this route returns.

  • PUT Update Order Status - Marketplace /partnerOrders/store/:id

    Allows the originating store to move an order that was created there to the next status, saving along with it the data that status requires.

  • PUT Upload Invoice XML - Marketplace /partnerOrders/store/:id/invoice

    Allows the originating store to attach the invoice (nota fiscal) XML to an order that was created there. The request body is the file itself, sent as binary content — the raw byte stream of the.xml. It is not multipart/form-data, there is no form field, and the XML does not go inside a JSON.

  • POST Send Item Tracking - Marketplace /partnerOrders/store/:id/complementaryInfo

    Allows the originating store to report, item by item, the status of each product in an order that originated in it.

  • GET Get Item Tracking - Marketplace /partnerOrders/store/:id/complementaryInfo

    Returns the tracking of the items of an order originated in your store — the active set.

  • DELETE Remove Item Tracking - Marketplace /partnerOrders/store/:id/complementaryInfo

    Deletes, in full, the item tracking of an order originated in your store.

Generated from the public API collection, published on 2026-09-04: api-docs.cws.digital.