Body Required

• adminNotes string | null

  Admin notes

• aftershipId string | null

  Aftership

• carrierPickupId integer(int32) | null

  Carrier pickup

• channelAttempts integer(int32) | null Required

  Channel attempts

  Default value is 0.

• channelError boolean | null

  Channel error

• channelNotification string | null Required

  Channel notification

  Values are trigger or mute. Default value is trigger.

• commercialInvoiceUrl string | null

  Commercial invoice url

• createdAt string(date-time)

  Created at

• days integer(int32) | null

  Days

• distanceUnit string | null Required

  Distance unit

  Values are in or cm. Default value is in.

• durationTerms string | null

  Duration terms

• externalId string | null

  External

• files object | null | array | boolean | integer | number | string

  Files

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• grams number | null Required

  Grams

  Default value is 0.

• id integer(int32)

  Id

• importSource string | null Required

  Import source

  Values are api, manual, platform, portal, or shippingEndpoint. Default value is manual.

• intercomMessageId string | null

  Intercom message

• inventoryStatus string Required

  Inventory status

  Values are notShipped or shipped. Default value is notShipped.

• labelError string | null

  Label error

• labelFileFormat string | null

  Label file format

  Values are png or pdf.

• labelFiles object | null | array | boolean | integer | number | string

  Label files

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• labelPrintStatus string | null Required

  Label print status

  Values are notPrinted, generating, or printed. Default value is notPrinted.

• labelProblem object | null | array | boolean | integer | number | string

  Label problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• labelRefund boolean | null Required

  Label refund

  Default value is false.

• labelUris object | null | array | boolean | integer | number | string

  Label uris

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• labelUrl string | null

  Label url

• manifestId integer(int32) | null

  Manifest

• muteError boolean | null Required

  Mute error

  Default value is false.

• packingDepth number | null Required

  Packing depth

  Default value is 2.4.

• packingHeight number | null Required

  Packing height

  Default value is 13.3.

• packingWidth number | null Required

  Packing width

  Default value is 11.5.

• pickupProblem object | null | array | boolean | integer | number | string

  Pickup problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• price number | null Required

  Price

  Default value is 0.

• printedLabel boolean | null Required

  Printed label

  Default value is false.

• printedLabelAt string(date-time) | null

  Printed label at

• provider string | null

  Provider

• purchaseId integer(int32) Required

  Purchase

• purchaseImportExternalId string | null

  Purchase import external

• quoteId string | null

  Quote

• reference string Required

  Reference

• requiresShippingApproval string | null Required

  Requires shipping approval

  Values are notRequired, approvalRequired, rateRequired, or approved. Default value is notRequired.

• saleId integer(int32) | null

  Sale

• sendShippingUpdateProblem object | null | array | boolean | integer | number | string

  Send shipping update problem

  Any of:

  object-1 object | null array-2 array | null boolean-3 boolean | null integer-4 integer | null number-5 number | null string-6 string | null
• serviceLevel string | null

  Service level

• serviceLevelTerms string | null

  Service level terms

• shipmentRouting string | null Required

  Shipment routing

  Values are customer, consolidated, or consolidatedInternational. Default value is customer.

• shippoLabelIds array[string] | null

  Shippo label ids

• source string | null Required

  Source

  Values are sale or dropship_purchase_import. Default value is sale.

• tags array[string] | null

  Tags

• totalWeight number(float) | null Required

  Total weight

  Default value is 0.

• trackingCompany string | null

  Tracking company

• trackingNumber string | null

  Tracking number

• trackingStatus string | null

  Tracking status

  Values are delivered, failure, pre_transit, returned, transit, or unknown.

• trackingStatusDate string(date-time) | null

  Tracking status date

• trackingStatusDetails string | null

  Tracking status details

• trackingUrl string | null

  Tracking url

• updatedAt string(date-time)

  Updated at

• userId integer(int32) | null

  User

• vendorExternalId string | null

  Vendor external

• weightUnit string | null Required

  Weight unit

  Values are g, kg, oz, or lb. Default value is g.