Path parameters

• id integer(int64) Required

  Numeric ID of the instance

  Minimum value is 1.

Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • adminNotes string | null

    Admin notes

  • aftershipId string | null

    Aftership

  • 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

  • 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
  • fulfillmentType string Required

    Fulfillment type

    Values are automated, manual, or adjusted. Default value is manual.

  • grams number | null Required

    Grams

    Default value is 0.

  • id integer(int32)

    Id

  • 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
  • labelRefund boolean | null Required

    Label refund

    Default value is false.

  • labelUrl string | null

    Label url

  • manifestId integer(int32) | null

    Manifest

  • muteError boolean | null Required

    Mute error

    Default value is false.

  • packed boolean | null Required

    Packed

    Default value is false.

  • packedAt string(date-time) | null

    Packed at

  • picked boolean | null Required

    Picked

    Default value is false.

  • pickedAt string(date-time) | null

    Picked at

  • 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

  • quoteId string | null

    Quote

  • reference string Required

    Reference

  • requiresShippingApproval string | null Required

    Requires shipping approval

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

  • saleId integer(int32) Required

    Sale

  • serviceLevel string | null

    Service level

  • serviceLevelTerms string | null

    Service level terms

  • shippedAt string(date-time) | null

    Shipped at

  • shippoLabelIds array[string] | null

    Shippo label ids

  • shipstationId string | null

    Shipstation

  • status string | null Required

    Status

    Values are pending or finalized. Default value is finalized.

  • tags array[string] | null

    Tags

  • 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

  • xeroId string | null

    Xero