Orders Core

Overview

The Orders Core API provides fundamental operations for managing orders in SellerCenter. Orders represent customer purchases and contain order items, customer information, shipping details, and payment information.

Core order operations include:

• Order listing: Retrieve collections of orders with extensive filtering options
• Order anonymization: Anonymize customer information in orders for GDPR/LGPD compliance
• Order retrieval: Get detailed information about specific orders
• Order search: Search orders and get autocomplete suggestions
• Order counters: Get approximate counts of orders by status

Important: Orders can be filtered by many criteria including status, dates, customer information, shipment details, and more. The counters endpoint provides eventually consistent data suitable for UI hints and dashboards.

Get List of Orders

GET /v2/orders

Summary: This endpoint allows you to receive a collection of orders.

Description: Get list of orders with filters

Parameters:

• X-Context (header, optional): Define is the request done by an admin or by a seller.
• limit (query, required): Defines the maximum number of items to be returned.
• offset (query, required): Defines the starting point in the collection of items to begin returning results from.
• section (query, optional): Search section
  • status_shipped - returns orders with order items status shipped
  • status_delivered - returns orders with order items status delivered
  • status_failed - returns orders with order items status failed
  • status_canceled - returns orders with order items status canceled
  • status_pending_all - returns orders with order items status pending and shipment_information_pending
  • status_pending - returns orders with order items status pending
  • status_ready_to_ship - returns orders with order items status ready_to_ship
  • status_payment_pending - returns orders with order items status payment_pending
  • status_shipment_information_pending - returns orders with order items status shipment_information_pending
  • status_returned - returns orders with order items status returned
  • status_return_shipped_by_customer - returns orders with order items status return_shipped_by_customer
  • status_return_rejected - returns orders with order items status return_rejected
  • status_return_waiting_for_approval - returns orders with order items status return_waiting_for_approval
  • status_return_delivered - returns orders with order items status return_delivered
  • group_economy - returns orders with pending status and economy shipment provider type
  • group_express - returns orders with pending status and express shipment provider type
  • group_standard - returns orders with pending status and standard shipment provider type
  • group_digital - returns orders with pending status and digital shipment provider type
  • group_sameday - returns orders with pending status and sameday shipment provider type
  • group_air - returns orders with pending status and air shipment provider type
  • group_surface - returns orders with pending status and surface shipment provider type
  • group_missing_external_invoice_access_key - returns orders with pending or canceled status and invoice key is empty
  • group_ready_to_ship_manifested - returns orders with ready to ship status and manifest is exists
  • group_ready_to_ship_nonmanifested - returns orders with ready to ship status and manifest is not exists
• dateStart (query, optional): Search by order creation or date time. Time information is optional. By default start time will be at 00:00:00.
• dateEnd (query, optional): Search by order creation date or date time. Time information is optional. By default end time will be at 23:59:59.
• orderNumbers[] (query, optional): Search by order number
• packed (query, optional): Search by packed status
  • fully_packed - all of order items packed
  • partially_packed - part of order items packed
  • not_packed - no order items packed
• customers[] (query, optional): Search by customer name (first name and last name)
• printedStatus (query, optional): Search by printed status
• tags[] (query, optional): Search by tag's numeric id.
• productSku[] (query, optional): Search by product sku
• delivery (query, optional): Search by delivery
  • shippedUnder24h - Orders with the status of the Order Item was set to shipped less or equal than 24 hours ago.
  • notShippedUnder24h - Orders with the status of the Order Item was set to shipped more than 24 hours ago.
  • notShippedUnder24BusinessHours - Orders with the status of the Order Item was set to shipped more than 24 business hours ago.
• shipmentType (query, optional, deprecated): Deprecated. Use shipmentTypes[] instead.
• shipmentTypes[] (query, optional): Search by shipment types.
• shipmentProviders[] (query, optional): Searchhhhh by shipment provider id (or -1 for orders have no shipment provider)
• paymentMethods[] (query, optional): Search by payment methods
• outlet (query, optional): Search orders from outlet only
• invoiceRequired (query, optional): If this field is set to "1" then only orders for which an invoice is required will be returned
• cancelationReasons[] (query, optional, deprecated): Search by cancelation reason id (this field name is marked deprecated and will be replaced by cancelationReasonIds)
• cancelationReasonIds[] (query, optional): Search by cancelation reason id
• fulfilmentType[] (query, optional): Search by fulfilment type
  • merchant - means the type of shipment from the seller's warehouse
  • venture - means the type of shipment from the venture's warehouse
• orderSources[] (query, optional): Search by order sources
• sellerNames[] (query, optional, deprecated): Search by seller id (this field name is marked deprecated and will be replaced by sellerIds)
• sellerIds[] (query, optional): Search by seller id
• updateDateStart (query, optional): Search by order item updated date or date time. Will return orders with at least one order item updated within the selected range. By default, the start time will be set to 00:00:00.
• updateDateEnd (query, optional): Search by order item updated date or date time. Will return orders with at least one order item updated within the selected range. By default, the end time will be set to 23:59:59.
• warehouses[] (query, optional): Search by warehouse name
• orderIds[] (query, optional): Array of numeric Order Ids
• includeVoucherDetails (query, optional): Include voucher details in response (only for orders with voucher) default: false
• includeProductSet (query, optional): Include product set information in response default: false
• sort (query, optional): The field to sort the results by.
• sortDir (query, optional): Define which if you like to sort ascending or descending. Default is ascending

Note:

• Supports extensive filtering by status, dates, customers, shipment types, payment methods, and many other criteria
• Returns paginated results with limit, offset, total, and hasNext fields
• Use X-Context header to specify admin or seller context
• Multiple filters can be combined for precise order retrieval

Anonymize Order Information

POST /v2/orders/anonymize

Summary: Anonymize order information

Description: Anonymize customer information in one or more orders. This endpoint supports two modes:

1. Default Mask Mode: When default_mask is provided, all customer data fields (names, addresses, etc.) will be replaced with the mask value.
2. Selective Update Mode: When specific fields are provided without default_mask, only those fields will be updated.

The operation processes orders in batch and returns detailed results for each order.

Request Body:

• order_numbers (array, required): Array of order numbers to anonymize (minimum 1 item)
• default_mask (string, optional): Default mask to apply to all fields if provided
• address_billing (object, optional): Billing address fields to update
  • first_name, last_name: Customer names for billing
  • phone, phone2: Primary and secondary phone numbers
  • address1 to address5: Address lines
  • city, postcode, country: Location details
  • customer_email: Email address for billing
• address_shipping (object, optional): Shipping address fields to update (same structure as billing)
• customer_first_name (string, optional): Customer's first name
• customer_last_name (string, optional): Customer's last name
• national_registration_number (string, optional): National registration number

Examples:

• Default mask: Apply "LGPD-1212" to all customer data fields
• Selective update: Update only specific fields like customer names and billing address
• Batch processing: Process multiple orders in a single request

Response Codes:

• 200: All orders processed successfully
• 206: Partial success - some orders processed, others failed
• 400: Bad request - validation errors or all orders failed

Note:

• Supports batch processing of multiple orders
• Returns detailed success/failure information for each order
• Useful for GDPR/LGPD compliance requirements
• When using default_mask, all customer fields are replaced with the mask value

Get Order by ID

GET /v2/orders/{orderId}

Summary: This endpoints allows you to receive a specific order.

Description: Getter for a specific order by id

Parameters:

• orderId (path, required): Numeric Order Id
• shipmentType (query, optional, deprecated): Deprecated. Use shipmentTypes[] instead.
• shipmentTypes[] (query, optional): Search by shipment types.
• includeProductSet (query, optional): Include product set information in response default: false

Note:

• Returns complete order details including all order items
• Use includeProductSet to get additional product set information
• Order status and history information is included in the response

Search Orders

GET /v2/orders/search

Summary: This endpoint allows you to search orders and get autocomplete suggestions for order numbers, order sources, customers, and products.

Description: Search orders for autocomplete suggestions

Parameters:

• key (query, required): Search key type
  • order_nr - search by order number
  • order_source - search by order source
  • customer - search by customer name
  • product - search by product name or SKU
  • cancelation-reason - search by cancelation reason
• query (query, required): Search query string to find matching orders
• filteredStatus (query, optional): Filter orders by status section (optional, defaults to status_pending)
  • status_shipped - returns orders with order items status shipped
  • status_delivered - returns orders with order items status delivered
  • status_failed - returns orders with order items status failed
  • status_canceled - returns orders with order items status canceled
  • status_pending_all - returns orders with order items status pending and shipment_information_pending
  • status_pending - returns orders with order items status pending
  • status_ready_to_ship - returns orders with order items status ready_to_ship
  • status_payment_pending - returns orders with order items status payment_pending
  • status_shipment_information_pending - returns orders with order items status shipment_information_pending
  • status_returned - returns orders with order items status returned
  • status_return_shipped_by_customer - returns orders with order items status return_shipped_by_customer
  • status_return_rejected - returns orders with order items status return_rejected
  • status_return_waiting_for_approval - returns orders with order items status return_waiting_for_approval
  • status_return_delivered - returns orders with order items status return_delivered
  • group_economy - returns orders with pending status and economy shipment provider type
  • group_express - returns orders with pending status and express shipment provider type
  • group_standard - returns orders with pending status and standard shipment provider type
  • group_digital - returns orders with pending status and digital shipment provider type
  • group_sameday - returns orders with pending status and sameday shipment provider type
  • group_air - returns orders with pending status and air shipment provider type
  • group_surface - returns orders with pending status and surface shipment provider type
  • group_missing_external_invoice_access_key - returns orders with pending or canceled status and invoice key is empty
  • group_ready_to_ship_manifested - returns orders with ready to ship status and manifest is exists
  • group_ready_to_ship_nonmanifested - returns orders with ready to ship status and manifest is not exists

Note:

• Returns autocomplete suggestions based on the search key type
• Supports searching by order number, order source, customer, or product
• Useful for building search interfaces with autocomplete

Get Order Counters

GET /v2/orders-counters

Summary: This endpoint will return the counter values for each orders states.

Description: Get approximate counters for orders groupped by filters. Please, read explanation about each counter in response model. This endpoint is suitable for getting quick information about count of orders, for example, when you develop own UI of SellerCenter and want to display to end user hint with count of pending orders. Data is eventually consistent, however there can be some delay in updating those counters.

Parameters:

• includeOrderCounters (query, optional): When set to false, excludes order counters (pending, ready to ship, shipped, etc.) from the response to improve performance
• includeReturnCounters (query, optional): When set to true, includes return counters in the response

Note:

• Returns counters for pending, ready_to_ship, shipped, delivered, cancelled orders
• Data is eventually consistent - may have slight delays
• Use includeReturnCounters to get return-related counters
• Suitable for dashboard displays and UI hints