PUT
/
v1
/
retailers
/
{retailer_pk}
/
shipments
/
{id}
/
acknowledge
/

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

Shipment ID

retailer_pk
number
required

Retailer ID

Body

application/json
order_id
integer
required

Order ID

batch_number
integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647
label_reference
string | null

Label reference

Maximum length: 30
shipping_method
object
shipping_account
object
tracking_number
string | null

Tracking number for shipment

Maximum length: 128
tracking
object
has_commercial_invoice
boolean

true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice

canceled_at
string | null

Time of cancellation (UTC format)

sold_to
object
ship_to
object
ship_from
object
ship_weight
number | null

Shipment weight

ship_width
number | null

Shipment width

ship_length
number | null

Shipment length

ship_height
number | null

Shipment height

shipping_provider_identifier
string | null

Identifier of the shipping provider

Maximum length: 64
error_logs
object
acknowledged_at
string | null

Time of acknowledgement (UTC format)

closed_at
string | null

Time of shipment closure (UTC format)

delivered_at
string | null

Time of delivery (UTC format)

shipped_at
string | null

Time of shipping (UTC format)

signature
enum<string> | null

Signature criteria

Available options:
required,
not_required,
adult
brand
object

Response

200 - application/json
order_id
integer
required

Order ID

id
integer

Shipment ID

batch_number
integer | null

Batch number of shipment

Required range: -2147483648 < x < 2147483647
label_reference
string | null

Label reference

Maximum length: 30
ordered_at
string

Time of shipment creation (UTC format)

customer_order_number
string

Customer order number

Minimum length: 1
retailer_order_number
string

Retailer order number

Minimum length: 1
purchase_order_number
string

Purchase order number

Minimum length: 1
shipping_method
object
shipping_account
object
tracking_number
string | null

Tracking number for shipment

Maximum length: 128
tracking_url
string

URL for tracking shipment

tracking
object
status
string

Status of shipment

Minimum length: 1
is_acknowledged
boolean

true: Shipment is acknowledged <br /> false: Shipment is not acknowledged

has_commercial_invoice
boolean

true: Shipment has commercial invoice <br /> Shipment does not have commercial invoice

canceled_at
string | null

Time of cancellation (UTC format)

sold_to
object
ship_to
object
ship_from
object
ship_weight
number | null

Shipment weight

ship_width
number | null

Shipment width

ship_length
number | null

Shipment length

ship_height
number | null

Shipment height

ship_girth
string

Shipment girth

ship_volume
string

Shipment volume

valid_packing_slip
boolean

true: Shipment has valid packing slip <br /> false: Shipment does not valid packing slip

valid_shipping_label
boolean

true: Shipment has valid shipping label <br /> false: Shipment does not valid valid shipping label

shipping_provider_identifier
string | null

Identifier of the shipping provider

Maximum length: 64
error_logs
object
acknowledged_at
string | null

Time of acknowledgement (UTC format)

closed_at
string | null

Time of shipment closure (UTC format)

delivered_at
string | null

Time of delivery (UTC format)

shipped_at
string | null

Time of shipping (UTC format)

updated_at
string

Time of shipment update (UTC format)

created_at
string

Time of shipment creation (UTC format)

shipment_lines
object[]
signature
enum<string> | null

Signature criteria

Available options:
required,
not_required,
adult
brand
object
invoice_number
string

Invoice number

Was this page helpful?

List fulfillments or shipments from vendorsGet active permits