Search Combinable Packages

GET

/fulfillment/202309/combinable_packages/search

Use this API to query orders eligible for combined shipping.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

Identifies the shop. Obtain it from the Get Authorized Shops API.

page_token

string

An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.

page_size

required

integer format: int64

>= 1 <= 50

The number of results to be returned per page. Valid range: [1-50].

Responses

200

Success

Media typeapplication/json

object

code

Status code; 0 means success.

integer format: int64

message

Success or failure message.

string

request_id

Request log ID.

string

data

object

combinable_packages

List of eligible packages that can be combined.

Array<object>

object

id

The pre-generated package ID obtained after calling the Search Draft Package API. Use this ID when confirming the package combination.

string

order_ids

List of order IDs for this package.

Array<string>

next_page_token

An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results.

string

total_count

The number of combinable packages counted by this result.

integer format: int64

Example

{
  "code": 0,
  "data": {
    "combinable_packages": [
      {
        "id": "57466538837665",
        "order_ids": [
          "57466538837665",
          "57466538837666"
        ]
      }
    ],
    "next_page_token": "6AsPQsUMvH3RkchNUPPh22NROHkE0D8pmq/N5M1kHYcZmtRyv9aVrNv65W7Q6tFA",
    "total_count": 10
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}