Shipping Label Generation Request

This request is an outbound call that generates shipping label data for the carrier.

This request is used when the packing or shipping from stores modules are enabled. The provider is the tenant, and the type is sync.

Body Params
boolean
required

Specifies a designator/indicator if the shipping label is a reprint.

If true, the shipping label is a reprint.

If false, the shipping label is not a reprint.

string
required

Specifies a client-based order identifier that is a combination of the customer order (CO) and purchase order (PO) number.

The order identifier/value is unique over a predefined period, like one year. In terms of Store Assist, this is the Buy Online Pick up In Store (BOPIS) part of an order. This designation applies in split orders, like online fulfillment v. store pickup.

string
required

Specifies a parent identifier used to set up hierarchies and groups of pickup points.

This is the identifier the client company already uses internally for the store.
It is useful for stores with multiple pickup points, such as curbside or in-store, in the same general location.
In addition, the identifier is the Client Center id against which trips are expected to be created when using Checkin requests.
The parameters parentPickupPointId and storeId are equivalent values.

string
required

Specifies the tenant identifier.

string

Specifies the status of the order, in terms of the shipping label generation process. Valid value is 22.

date-time
required

Specifies the ship date-timestamp in International Organization for Standardization (ISO) 8601 format.

date-time
required

Specifies the delivery date-timestamp in International Organization for Standardization (ISO) 8601 format.

string

Specifies the carrier method identifier.

string
required

Specifies the cut time timestamp, in 24-hour format.

date
required

Specifies the date of label generation.

string
required

Specifies the shipping label format, like Zebra Programming Language (ZPL).
Valid values are:
| Data Format | Printer Type |
| --- | --- |
| ZPL | ZEBRA |
| PDF | LASER |

toAddress
object
required

Specifies an object for the "to" or recipient address.

fromAddress
object
required

Specifies an object for the "from" or shipping address.

packingSection
array of objects
required

Specifies an array of objects for the packing.

packingSection*
additionalProperties
object

Specifies a map of string key and object value for additional properties.

Headers
int64
required

Specifies the store identifier.

Responses

400

Validation error

404

resource not found

Language
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json