Responses

• • 200

  Successful response

  Hide response attributes Show response attributes object

  • attribute string | null

    Attribute

  • columnType string | null

    Column type

    Values are attribute, placeholder, or orderFlag.

  • countryFormat string | null Required

    Country format

    Values are full, alpha2, or alpha3. Default value is alpha2.

  • createdAt string(date-time)

    Created at

  • dateFormat string | null

    Date format

  • formatReference boolean | null Required

    Adds the prefix to the purchase references (e.g. #JET1001-01 instead of just 1001-01). This may be useful when you have multiple sales channels to avoid duplicate order references.

    Default value is false.

  • header string Required

    Header

  • id integer(int32)

    Id

  • object string | null

    Object

    Values are channel, company, currency, customer, dropship_provider, inventory_feed_variant, product, purchase_item, purchase_shipping_rate, purchase, sale_item, sale_shipping_rate, sale, tracking_event, transfer_refund, transfer, variant, or vendor.

  • orderEnd string | null

    Order end

  • orderMiddle string | null

    Order middle

  • orderStart string | null

    Order start

  • placeholder string | null

    Placeholder

  • position integer(int32) | null

    Position

  • propertyName string | null

    Property name

  • stateFormat string | null

    State format

    Values are original, full, or abbreviation.

  • templateId integer(int32) Required

    Template

  • updatedAt string(date-time)

    Updated at

  • weightUnit string | null

    Weight unit

    Values are g, kg, oz, or lb.