Skip to main content

Create parcel group

Creates a new parcel group.

Request Body REQUIRED

Options for the new parcel group.

OrderIds int32[]

The order ids contained in this parcel group. Required.

OrderRowIds int32[]

Limits which order rows are included for each order defined in OrderIds. Use this to create partial deliveries.
If any order rows are defined for a given order then only those order rows will be used, eg a partial delivery.
If no order rows are defined for a given order then all remaining undelivered order rows will be implied.
Optional.

MarkAsDelivered boolean

Set to true to automatically mark orders as delivered upon creation of the parcel group.
Defaults to false.
Optional.

SendDeliveryEmail boolean

Set to true to automatically send delivery email upon creation of the parcel group.
Requires that MarkAsDelivered is also set to true.
Defaults to false.
Optional.

SignalCapturesCreated boolean

Set to true to create captures and automatically signal capture events upon creation of the parcel group.
Defaults to false.
Optional.

Responses
200

The id of the created parcel group.

Schema OPTIONAL
Resource int32 OPTIONAL

The resource on which the action was taken.

Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.

400

Bad request.

Schema OPTIONAL
Message string OPTIONAL

A status message for the action taken.

Details string[] OPTIONAL

Any validation messages for the data on the current action.