Create A Shipment

Creates a shipment by grouping together multiple packages into logical shipments

POST /commerce/orders/{orderId}/shipments

Error

A valid request URL is required to generate request examples

200

[
  {
    "auditInfo": {
      "createBy": "<string>",
      "createDate": "2023-11-07T05:31:56Z",
      "updateBy": "<string>",
      "updateDate": "2023-11-07T05:31:56Z"
    },
    "availableActions": [
      "<string>"
    ],
    "changeMessages": [
      {
        "amount": 123,
        "appId": "<string>",
        "appKey": "<string>",
        "appName": "<string>",
        "attributes": {},
        "correlationId": "<string>",
        "createDate": "2023-11-07T05:31:56Z",
        "id": "<string>",
        "identifier": "<string>",
        "message": "<string>",
        "metadata": "<unknown>",
        "newValue": "<string>",
        "oldValue": "<string>",
        "subject": "<string>",
        "subjectType": "<string>",
        "success": true,
        "userFirstName": "<string>",
        "userId": "<string>",
        "userLastName": "<string>",
        "userScopeType": "<string>",
        "verb": "<string>"
      }
    ],
    "code": "<string>",
    "fulfillmentDate": "2023-11-07T05:31:56Z",
    "fulfillmentLocationCode": "<string>",
    "id": "<string>",
    "items": [
      {
        "fulfillmentItemType": "<string>",
        "lineId": 123,
        "optionAttributeFQN": "<string>",
        "productCode": "<string>",
        "quantity": 123
      }
    ],
    "status": "<string>",
    "attributes": {},
    "carrier": "<string>",
    "fxcbDocumentsUrl": "<string>",
    "fxcbPackNotificationId": "<string>",
    "hasLabel": true,
    "integratorId": "<string>",
    "labelFormat": "<string>",
    "manifestId": "<string>",
    "measurements": {
      "height": {
        "unit": "<string>",
        "value": 123
      },
      "length": {
        "unit": "<string>",
        "value": 123
      },
      "weight": {
        "unit": "<string>",
        "value": 123
      },
      "width": {
        "unit": "<string>",
        "value": 123
      }
    },
    "packageId": "<string>",
    "packagingType": "<string>",
    "packingSlipItemDetails": [
      {
        "attributes": {},
        "lineId": 123,
        "originalOrderItemId": "<string>",
        "quantity": 123
      }
    ],
    "packingSlipNumber": 123,
    "returnCarrier": "<string>",
    "returnTrackingNumbers": [
      "<string>"
    ],
    "returnTrackings": [
      {
        "attributes": {},
        "number": "<string>",
        "url": "<string>"
      }
    ],
    "shipmentId": "<string>",
    "shippingMethodCode": "<string>",
    "shippingMethodName": "<string>",
    "signatureRequired": true,
    "trackingNumber": "<string>",
    "trackingNumbers": [
      "<string>"
    ],
    "trackings": [
      {
        "attributes": {},
        "number": "<string>",
        "url": "<string>"
      }
    ]
  }
]

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme.

Path Parameters

orderId · string · required

Unique identifier of the order which is ready to be shipped.

Query Parameters

responseFields · string

limits which fields are returned in the response body

Body

application/json

Package ids to use in creating shipments.

Response

200

application/json

Success

auditInfo · object

Show child attributes

availableActions · string[] | null

Actions that can be taken on this fulfillment unit

changeMessages · object[] | null

Change messages related to the fulfillment unit.

Show child attributes

code · string | null

A human-readable identifier for this fulfillment unit. If not set on create, will be autogenerated as a string of the form {fulfillmentUnitType} #{next available int}

fulfillmentDate · string<date-time> | null

Date of the pickup

fulfillmentLocationCode · string | null

Location code from which to obtain this item

id · string | null

ID of the fulfillment unit.

items · object[] | null

List of items in the fulfillment unit

Show child attributes

status · string | null

Status of the fulfillment unit See FulfillmentStatusConst

attributes · object

Show child attributes

carrier · string | null

Carrier of this package

fxcbDocumentsUrl · string | null

fxcbPackNotificationId · string | null

hasLabel · boolean

If there is a shipping label present for this Package, this will be set to true

integratorId · string | null

labelFormat · string | null

manifestId · string | null

measurements · object

Physical dimensions of the package required to ship the product and its weight.

Show child attributes

packageId · string | null

packagingType · string | null

Packaging type of this package

packingSlipItemDetails · object[] | null

PackingSlipItemDetails for this package

Show child attributes

packingSlipNumber · integer<int32> | null

PackingSlipNumber for this package

returnCarrier · string | null

returnTrackingNumbers · string[] | null

returnTrackings · object[] | null

Show child attributes

shipmentId · string | null

ID of the related shipment

shippingMethodCode · string | null

Code describing the shipping method.

shippingMethodName · string | null

Name of the shipping method

signatureRequired · boolean | null

SignatureRequired for this package

trackingNumber · string | null

Tracking number of this package (to support classic use cases)

trackingNumbers · string[] | null

Tracking number of this package

trackings · object[] | null

Tracking number and url data for this package

Show child attributes