Combine Package

POST

/fulfillment/202309/packages/combine

Use this API to combine orders from each specified package into new fulfillment packages.

Authorizations

• accessToken

Parameters

Query Parameters

shop_cipher

required

string

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

Request Body^required

Media typeapplication/json

object

combinable_packages

required

The packages to combine. Provide at least one package. Each item identifies a package and can specify the order IDs to include.

Array<object>

object

id

required

The package ID.

string

order_ids

The order IDs to include when combining the package identified by id.

Array<string>

Example

{
  "combinable_packages": [
    {
      "id": "12321313133",
      "order_ids": [
        "1233213123123",
        "32132131231"
      ]
    }
  ]
}

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

packages

Return list of successfully combined packages.

Array<object>

object

id

The new package ID generated after the package has been successfully combined.

string

order_ids

List of order IDs corresponding to a new combined package ID.

Array<string>

errors

The errors returned for packages that could not be combined.

Array<object>

object

code

The failure reason code.

integer format: int64

message

The failure reason message.

string

detail

Error detail.

object

package_id

Package ID.

string

Example

{
  "code": 0,
  "data": {
    "packages": [
      {
        "id": "413234134123412",
        "order_ids": [
          "1233213123123",
          "32132131231"
        ]
      }
    ],
    "errors": [
      {
        "code": 10007014,
        "message": "fulfillment not allow combine package",
        "detail": {
          "package_id": "1231231231231313123132"
        }
      }
    ]
  },
  "message": "Success",
  "request_id": "202203070749000101890810281E8C70B7"
}