Get Order List API

Endpoint

GET /order

Headers

Key	Value
Authorization	Bearer change_to_your_access_token
X-S2-Organization	95d73baf-76ba-4bea-86ac-1534c5e5d4aa

Request Parameters (Query String)

Key	Value	Required	Default
limit	100	No	100
offset	0	No	0
term	order_id	No	null

Pagination

For pagination of Order List API and Order List API, you can pass the limit and offset query parameters. The default value for limit is 100 and for offset is 0. The maximum value for limit is 100.

Response Body

Field	Type	Description
items	array	List of orders. See Order Object for details.
total	integer	Total number of orders matching the query parameters.

Order Object

Field	Type	Description
id	string	Unique identifier for the order
organization	Organization Object	Information about the organization. See Organization Object for details.
account	Account Object	Information about the account. See Account Object for details.
accountSubChannel	string	Sub-channel information (if any)
channelOrderId	string	Order identifier in the sales channel
channelOrderIdAlt	string	Alternative order identifier in the sales channel
channelOrderIdAlt2	string	Second alternative order identifier in the sales channel
channelShippingMethod	string	Shipping method specified by the channel
shippingAddress	Address Object	Shipping address details. See Address Object for details.
shippingOverrideAddress	Address Object	Override shipping address (if any). See Address Object for details.
billingAddress	Address Object	Billing address details. See Address Object for details.
channelOrderDate	string	Date when the order was created in the channel (ISO 8601 format)
status	string	Current status of the order (e.g., "UNFULFILLED")
assignStatus	string	Assignment status of the order (e.g., "ASSIGNED")
archived	boolean	Whether the order has been archived
currencyId	string	Currency code for the order (e.g., "EUR")
createdAt	string	Timestamp when the order was created (ISO 8601 format)
updatedAt	string	Timestamp when the order was last updated (ISO 8601 format)
shipByDate	string	Date by which the order should be shipped (ISO 8601 format)
deliverByDate	string	Date by which the order should be delivered (ISO 8601 format)
items	array	List of items in the order. See Order Item Object for details.

Organization Object

Field	Type	Description
id	string	Unique identifier for the organization
name	string	Name of the organization
createdAt	string	Timestamp when the organization was created (ISO 8601 format)
updatedAt	string	Timestamp when the organization was last updated (ISO 8601 format)

Account Object

Field	Type	Description
id	string	Unique identifier for the account
organization	Organization Object	Information about the organization. See Organization Object for details.
name	string	Name of the account
type	string	Type of account (e.g., "MARKETPLACE_GENERIC")
autoAssignOrdersToWarehouse	string	Warehouse ID for automatic order assignment (if enabled)
createdAt	string	Timestamp when the account was created (ISO 8601 format)
updatedAt	string	Timestamp when the account was last updated (ISO 8601 format)

Address Object

Field	Type	Description
name	string	The name associated with the address
company	string	Company name
address1	string	Primary street address
address2	string	Additional address information
city	string	City name
state	string	State or province
postalCode	string	Postal or ZIP code
countryId	string	Country code in ISO 3166-1 alpha-2 format (e.g., "US")
phone	string	Contact phone number
email	string	Contact email address

Order Item Object

Field	Type	Description
product	Product Object	Information about the product. See Product Object for details
quantity	integer	Quantity of the product ordered

Product Object

Field	Type	Description
id	string	Unique identifier for the product
organization	Organization Object	Organization that owns the product
sku	string	Stock keeping unit
brand	Brand Object	Brand information. See Brand Object for details
gtin	string	Global Trade Item Number
name	string	Product name
remarks	string	Additional remarks about the product
imageMain	string	URL of the main product image
packageLengthMm	number	Package length in millimeters
packageWidthMm	number	Package width in millimeters
packageHeightMm	number	Package height in millimeters
shippingWeightKg	number	Shipping weight in kilograms
caseUnit	string	Unit of measurement for cases (e.g., "EACH", "CARTON")
casePack	integer	Number of items per case
caseLengthMm	number	Case length in millimeters
caseWidthMm	number	Case width in millimeters
caseHeightMm	number	Case height in millimeters
caseWeightKg	number	Case weight in kilograms
condition	string	Product condition (e.g., "NEW")
serialNumberRequired	boolean	Whether serial number is required
expiryDateRequired	boolean	Whether expiry date is required
unknown	boolean	Whether the product is unknown
createdAt	string	Timestamp when the product was created (ISO 8601 format)
updatedAt	string	Timestamp when the product was last updated (ISO 8601 format)
otherIds	array	List of other identifiers associated with the product

Brand Object

Field	Type	Description
id	string	Unique identifier for the brand
name	string	Brand name
nameNormalized	string	Normalized version of the brand name
createdAt	string	Timestamp when the brand was created (ISO 8601 format)

Response Example

json

{
  "items": [
    {
      "id": "2fe75f59-9141-4aa7-a00d-90defe870888",
      "organization": {
        "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
        "name": "test organization",
        "createdAt": "2024-03-05T22:17:23.520948Z",
        "updatedAt": "2024-04-09T21:15:15.615765Z"
      },
      "account": {
        "id": "1ac48942-405a-4841-a7d8-708f50dbe888",
        "organization": {
          "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
          "name": "test organization",
          "createdAt": "2024-03-05T22:17:23.520948Z",
          "updatedAt": "2024-04-09T21:15:15.615765Z"
        },
        "name": "test organization",
        "type": "MARKETPLACE_GENERIC",
        "autoAssignOrdersToWarehouse": null,
        "createdAt": "2024-04-11T02:52:03.791286Z",
        "updatedAt": "2024-04-11T02:52:03.791286Z"
      },
      "accountSubChannel": null,
      "channelOrderId": "896-7715607-1523888",
      "channelOrderIdAlt": null,
      "channelOrderIdAlt2": "432745a6-f1be-4e6d-89c5-857617e13888",
      "channelShippingMethod": "Priority",
      "shippingAddress": {
        "name": "Devin test",
        "company": "Haley test",
        "address1": "123 Test St",
        "address2": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94888",
        "countryId": "US",
        "phone": "(818) 615-8888",
        "email": "test@sellersoft.com"
      },
      "shippingOverrideAddress": null,
      "billingAddress": {
        "name": "Devin test",
        "company": "Haley test",
        "address1": "123 Test St",
        "address2": "",
        "city": "San Francisco",
        "state": "CA",
        "postalCode": "94888",
        "countryId": "US",
        "phone": "(312) 617-8888 8888",
        "email": "test@sellersoft.com"
      },
      "channelOrderDate": "2024-04-22T08:01:47.609Z",
      "status": "UNFULFILLED",
      "assignStatus": "ASSIGNED",
      "archived": false,
      "currencyId": "EUR",
      "createdAt": "2024-04-25T06:21:49.488547Z",
      "updatedAt": "2024-06-03T03:40:41.743844Z",
      "shipByDate": null,
      "deliverByDate": null,
      "items": [
        {
          "product": {
            "id": "440352eb-241a-4cac-834f-e0980ffc8888",
            "organization": {
              "id": "3f424caf-0eba-4813-b3e7-7ca0393af8888",
              "name": "test organization",
              "createdAt": "2024-03-05T22:17:23.520948Z",
              "updatedAt": "2024-04-09T21:15:15.615765Z"
            },
            "sku": "SKU-N-BLUE",
            "brand": {
              "id": "5643b7ee-7df1-48c6-b690-1e29ffa88888",
              "name": "",
              "nameNormalized": "",
              "createdAt": "2024-03-05T22:17:28.679732Z"
            },
            "gtin": "",
            "name": "SKU N Blue",
            "remarks": "",
            "imageMain": "",
            "packageLengthMm": 1500.0,
            "packageWidthMm": 260.0,
            "packageHeightMm": 810.0,
            "shippingWeightKg": 34.0,
            "caseUnit": "CARTON",
            "casePack": 1,
            "caseLengthMm": 0.0,
            "caseWidthMm": 0.0,
            "caseHeightMm": 0.0,
            "caseWeightKg": 0.0,
            "condition": "NEW",
            "serialNumberRequired": false,
            "expiryDateRequired": false,
            "unknown": false,
            "createdAt": "2024-03-05T22:20:44.106742Z",
            "updatedAt": "2024-04-01T14:31:19.875675Z",
            "otherIds": []
          },
          "quantity": 7
        },
        {
          "product": {
            "id": "bab7c35b-2ecb-4b40-be82-8dc1e0a86888",
            "organization": {
              "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
              "name": "test organization",
              "createdAt": "2024-03-05T22:17:23.520948Z",
              "updatedAt": "2024-04-09T21:15:15.615765Z"
            },
            "sku": "SKU-GREY",
            "brand": {
              "id": "5643b7ee-7df1-48c6-b690-1e29ffa8a888",
              "name": "",
              "nameNormalized": "",
              "createdAt": "2024-03-05T22:17:28.679732Z"
            },
            "gtin": "",
            "name": "SKU GREY",
            "remarks": "",
            "imageMain": "",
            "packageLengthMm": 1500.0,
            "packageWidthMm": 260.0,
            "packageHeightMm": 810.0,
            "shippingWeightKg": 35.0,
            "caseUnit": "CARTON",
            "casePack": 1,
            "caseLengthMm": 0.0,
            "caseWidthMm": 0.0,
            "caseHeightMm": 0.0,
            "caseWeightKg": 0.0,
            "condition": "NEW",
            "serialNumberRequired": false,
            "expiryDateRequired": false,
            "unknown": false,
            "createdAt": "2024-03-05T22:20:44.132006Z",
            "updatedAt": "2024-04-01T14:31:19.885955Z",
            "otherIds": []
          },
          "quantity": 6
        },
        {
          "product": {
            "id": "f4053402-e79b-45c2-8621-377d28060888",
            "organization": {
              "id": "3f424caf-0eba-4813-b3e7-7ca0393af888",
              "name": "test organization",
              "createdAt": "2024-03-05T22:17:23.520948Z",
              "updatedAt": "2024-04-09T21:15:15.615765Z"
            },
            "sku": "SKU-BLACK",
            "brand": {
              "id": "5643b7ee-7df1-48c6-b690-1e29ffa8ab33",
              "name": "",
              "nameNormalized": "",
              "createdAt": "2024-03-05T22:17:28.679732Z"
            },
            "gtin": "888888888",
            "name": "SKU Black",
            "remarks": "",
            "imageMain": "",
            "packageLengthMm": 1470.0,
            "packageWidthMm": 310.0,
            "packageHeightMm": 790.0,
            "shippingWeightKg": 34.0,
            "caseUnit": "EACH",
            "casePack": 0,
            "caseLengthMm": 0.0,
            "caseWidthMm": 0.0,
            "caseHeightMm": 0.0,
            "caseWeightKg": 0.0,
            "condition": "NEW",
            "serialNumberRequired": false,
            "expiryDateRequired": false,
            "unknown": false,
            "createdAt": "2024-03-05T22:20:44.087204Z",
            "updatedAt": "2024-03-05T22:20:44.087204Z",
            "otherIds": []
          },
          "quantity": 13
        }
      ]
    }
  ],
  "total": 1
}

Get Order List API ​

Endpoint ​

Headers ​

Request Parameters (Query String) ​

Pagination ​

Response Body ​

Order Object ​

Organization Object ​

Account Object ​

Address Object ​

Order Item Object ​

Product Object ​

Brand Object ​

Response Example ​