Responses

• 200 application/json

  Successful response

  Hide response attributes Show response attributes object

  • addressLineOne string | null

    Address line one

  • addressLineTwo string | null

    Address line two

  • billingAddressLineOne string | null

    Billing address line one

  • billingAddressLineTwo string | null

    Billing address line two

  • billingCity string | null

    Billing city

  • billingCountry string | null

    Billing country

  • billingFirstName string | null

    Billing first name

  • billingLastName string | null

    Billing last name

  • billingName string | null

    Billing name

  • billingState string | null

    Billing state

  • billingZip string | null

    Billing zip

  • city string | null

    City

  • countries array[string] | null Required

    Countries

    Default value is [] (empty).

  • countriesFilter string | null Required

    Countries filter

    Values are all, domestic, rest_of_world, exclude, or include. Default value is all.

  • country string | null

    Country

  • createdAt string(date-time)

    Created at

  • defaultReturnStatus string | null Required

    Default return status

    Values are draft, requested, finalized, shipped, or received. Default value is received.

  • firstName string | null

    First name

  • id integer(int32)

    Id

  • includeLabelInPackingSlip boolean | null

    Include label in packing slip

  • labelFormat string | null Required

    Label format

    Values are png, pdf, pdf_4x6, or pdf_4x8. Default value is png.

  • lastName string | null

    Last name

  • name string | null

    Name

  • pdfLegal string | null

    Pdf legal

  • setInvoiceAddresss boolean | null

    Set invoice addresss

  • shippingRateId integer(int32) | null

    Shipping rate

  • skipOnlineInventory boolean Required

    Skip online inventory

    Default value is false.

  • state string | null

    State

  • states array[string] | null Required

    States

    Default value is [] (empty).

  • statesFilter string | null Required

    States filter

    Values are all, exclude, or include. Default value is all.

  • status string | null Required

    Status

    Values are active or archived. Default value is active.

  • updatedAt string(date-time)

    Updated at

  • zip string | null

    Zip

  • zips array[string] | null Required

    Zips

    Default value is [] (empty).

  • zipsFilter string | null Required

    Zips filter

    Values are all, exclude, include, or startsWith. Default value is all.