Cart order updated

Body

application/json

connection_id

string

required

Example:

"connection_id"

data

CartOrderSchema · object

required

Show child attributes

data.id

string

The unique ID of the order.

Example:

"order_id"

data.order_number

string

The order number assigned by the platform. Defaults to order ID.

Example:

"order_number"

data.created_date

string<date-time>

The date the order was created.

Example:

"2022-01-01T00:00:00Z"

data.updated_date

string<date-time>

The date the order was last updated.

Example:

"2022-01-02T05:05:05Z"

data.status

enum<string>

The status of the order. See the order information for more details.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

data.raw_status

string | null

The raw status (if available) returned directly from the platform.

Example:

"raw_status"

data.requested_shipping_method

string | null

The type of shipping method requested by the customer.

Example:

"Standard"

data.shipping_method_id

string | null

The ID of the actual shipping method.

Example:

"shipping_method_id"

data.shipping_method_name

string | null

The name of the actual shipping method.

Example:

"Standard Shipping"

data.carrier_id

string | null

The ID of the carrier used to ship the order.

Example:

"carrier_id"

data.carrier_name

string | null

The name of the carrier used to ship the order.

Example:

"Carrier Name"

data.invoice_currency_code

string

The currency used for this order. If not provided explicitly, defaults to USD.

Example:

"USD"

data.total_price

number | null

The total price a customer paid for the order.

Example:

13.49

data.total_tax

number | null

The total tax on the order.

Example:

1.5

data.total_discount

number | null

The total amount discounted from the order.

Example:

2.5

data.total_shipping

number | null

The total shipping cost for the order incurred by the customer.

Example:

3.5

data.ship_to_address

ShipToAddress · object

Show child attributes

data.ship_to_address.full_name

string | null

required

Example:

"John Doe"

data.ship_to_address.company

string | null

required

Example:

"Company"

data.ship_to_address.address1

string | null

required

Example:

"123 Main St"

data.ship_to_address.address2

string | null

required

Example:

"Apt 2"

data.ship_to_address.address3

string | null

required

Example:

"Floor 3"

data.ship_to_address.city

string | null

required

Example:

"New York"

data.ship_to_address.state

string | null

required

Example:

"NY"

data.ship_to_address.postal_code

string | null

required

Example:

"10001"

data.ship_to_address.country

string | null

required

Example:

"United States"

data.ship_to_address.phone_number

string | null

required

Example:

"123-456-7890"

data.ship_to_address.email_address

string | null

required

Example:

"[email protected]"

data.bill_to_address

BillToAddress · object

Show child attributes

data.bill_to_address.full_name

string | null

required

Example:

"John Doe"

data.bill_to_address.address1

string | null

required

Example:

"123 Main St"

data.bill_to_address.address2

string | null

required

Example:

"Apt 2"

data.bill_to_address.address3

string | null

required

Example:

"Floor 3"

data.bill_to_address.city

string | null

required

Example:

"New York"

data.bill_to_address.state

string | null

required

Example:

"NY"

data.bill_to_address.postal_code

string | null

required

Example:

"10001"

data.bill_to_address.country

string | null

required

Example:

"United States"

data.earliest_ship_date

string<date-time> | null

The earliest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

data.latest_ship_date

string<date-time> | null

The latest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

data.line_items

CartOrderLineItem · object[]

List of the products included in the order.

Show child attributes

data.line_items.line_item_id

string

required

The ID of the line item.

Example:

"line_item_id"

data.line_items.product_id

string

required

The ID of the product. Can be passed into the Cart Product endpoint for more details.

data.line_items.product_sku

string | null

required

data.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.line_items.parent_product_sku

string | null

required

data.line_items.quantity

integer

required

Example:

1

data.line_items.unit_price

number | null

required

The price of the product in the currency specified by invoice_currency_code.

Example:

10.99

data.line_items.discount

number | null

required

The unit amount discounted from the product for this order. This is the amount of discount per unit of the product.

Example:

1.5

data.line_items.tax

number | null

required

The unit amount of tax on the product for this order. This is the amount of tax per unit of the product

Example:

0.5

Example:

[
  {
    "line_item_id": "line_item_id",
    "product_id": null,
    "product_sku": null,
    "parent_product_id": null,
    "parent_product_sku": null,
    "quantity": 1,
    "unit_price": 10.99,
    "discount": 1.5,
    "tax": 0.5
  }
]

data.shipping_groups

CartOrderShippingGroup · object[]

Sets of line items that will be fulfilled together from the same locations. Only applies in Shopify, as fulfillmentOrders.

Show child attributes

data.shipping_groups.shipping_group_id

string

required

The ID of the shipping_group.

Example:

"shipping_group_id"

data.shipping_groups.created_date

string<date-time>

required

The date the shipping_group was created.

Example:

"2022-01-01T00:00:00Z"

data.shipping_groups.updated_date

string<date-time>

required

The date the shipping_group was last updated.

Example:

"2022-01-02T05:05:05Z"

data.shipping_groups.raw_status

string | null

required

The raw status (if available) of the shipping group returned directly from the integration.

Example:

"raw_status"

data.shipping_groups.status

enum<string> | null

required

The status of the shipping group.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

data.shipping_groups.warehouse_id

string

required

The ID of the warehouse that the shipping group will send from. Subject to change.

Example:

"warehouse_id"

data.shipping_groups.line_items

CartOrderShipmentGroupLineItem · object[]

required

List of the products in the shipping group.

Show child attributes

data.shipping_groups.line_items.line_item_id

string

required

The ID of the line item in the shipping group.

Example:

"shipping_group_line_item_id"

data.shipping_groups.line_items.product_id

string

required

The ID of the product.

data.shipping_groups.line_items.product_sku

string | null

required

data.shipping_groups.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.shipping_groups.line_items.quantity

integer

required

Example:

0

data.shipments

CartOrderShipment · object[]

List of the shipments sent out to the customer.

Show child attributes

data.shipments.shipment_id

string

required

The ID of the shipment.

Example:

"shipment_id"

data.shipments.raw_status

string | null

required

The raw status (if available) of the shipment returned directly from the integration.

Example:

"raw_status"

data.shipments.status

enum<string> | null

required

The status of the shipment.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

data.shipments.warehouse_id

string | null

required

The warehouse the shipment was shipped from. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id"

data.shipments.shipping_method_id

string | null

required

The ID of the shipping method used for the shipment.

Example:

"shipment_shipping_method_id"

data.shipments.shipping_method_name

string | null

required

The name of the shipping method used for the shipment.

Example:

"shipment_shipping_method_name"

data.shipments.carrier_id

string | null

required

The ID of the carrier used to ship the shipment.

Example:

"carrier_id"

data.shipments.carrier_name

string | null

required

The name of the carrier used to ship the shipment.

Example:

"carrier_name"

data.shipments.tracking_number

string | null

required

The tracking number for the shipment.

data.shipments.tracking_url

string | null

required

The URL for the tracking number.

Example:

"https://www.example.com/tracking"

data.shipments.line_items

CartOrderShipmentLineItem · object[]

required

List of the products listed in the shipment.

Show child attributes

data.shipments.line_items.shipment_line_item_id

string

required

The ID of the line item in the shipment.

data.shipments.line_items.product_id

string

required

The ID of the product.

data.shipments.line_items.product_sku

string | null

required

data.shipments.line_items.parent_product_id

string | null

required

The ID of the product's parent.

data.shipments.line_items.parent_product_sku

string | null

required

data.shipments.line_items.quantity

integer

required

Example:

0

data.shipments.shipping_groups

string[]

required

List of the shipping groups included in the shipment. Only applies in Shopify, as fulfillmentOrders.

The ID of the shipping group included in the shipment.

Example:

["sg_id_1", "sg_id_2"]

data.shipments.created_date

string<date-time> | null

required

The date the shipment was created.

Example:

"2022-01-01T00:00:00Z"

data.shipments.updated_date

string<date-time> | null

required

The date the shipment was last updated.

Example:

"2022-01-02T05:05:05Z"

data.external_system_url

string | null

URL link to the order in the external system (WMS/Freight etc).

Example:

"https://example.com/order/123"

data.additional_fields

object

Integration-specific fields

Show child attributes

data.additional_fields.{key}

any

Example:

{ "key": "value" }

event_type

string

required

Example:

"cart-order.updated"

integration_name

string

required

Example:

"integration_name"

integration_type

string

required

Example:

"cart"

previous_attributes

CartOrderSchema · object

required

Show child attributes

previous_attributes.id

string

The unique ID of the order.

Example:

"order_id"

previous_attributes.order_number

string

The order number assigned by the platform. Defaults to order ID.

Example:

"order_number"

previous_attributes.created_date

string<date-time>

The date the order was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.updated_date

string<date-time>

The date the order was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.status

enum<string>

The status of the order. See the order information for more details.

Available options:

open,

confirmed,

processing,

partially_fulfilled,

fulfilled,

exception,

cancelled,

backordered,

other

Example:

"open"

previous_attributes.raw_status

string | null

The raw status (if available) returned directly from the platform.

Example:

"raw_status"

previous_attributes.requested_shipping_method

string | null

The type of shipping method requested by the customer.

Example:

"Standard"

previous_attributes.shipping_method_id

string | null

The ID of the actual shipping method.

Example:

"shipping_method_id"

previous_attributes.shipping_method_name

string | null

The name of the actual shipping method.

Example:

"Standard Shipping"

previous_attributes.carrier_id

string | null

The ID of the carrier used to ship the order.

Example:

"carrier_id"

previous_attributes.carrier_name

string | null

The name of the carrier used to ship the order.

Example:

"Carrier Name"

previous_attributes.invoice_currency_code

string

The currency used for this order. If not provided explicitly, defaults to USD.

Example:

"USD"

previous_attributes.total_price

number | null

The total price a customer paid for the order.

Example:

13.49

previous_attributes.total_tax

number | null

The total tax on the order.

Example:

1.5

previous_attributes.total_discount

number | null

The total amount discounted from the order.

Example:

2.5

previous_attributes.total_shipping

number | null

The total shipping cost for the order incurred by the customer.

Example:

3.5

previous_attributes.ship_to_address

ShipToAddress · object

Show child attributes

previous_attributes.ship_to_address.full_name

string | null

required

Example:

"John Doe"

previous_attributes.ship_to_address.company

string | null

required

Example:

"Company"

previous_attributes.ship_to_address.address1

string | null

required

Example:

"123 Main St"

previous_attributes.ship_to_address.address2

string | null

required

Example:

"Apt 2"

previous_attributes.ship_to_address.address3

string | null

required

Example:

"Floor 3"

previous_attributes.ship_to_address.city

string | null

required

Example:

"New York"

previous_attributes.ship_to_address.state

string | null

required

Example:

"NY"

previous_attributes.ship_to_address.postal_code

string | null

required

Example:

"10001"

previous_attributes.ship_to_address.country

string | null

required

Example:

"United States"

previous_attributes.ship_to_address.phone_number

string | null

required

Example:

"123-456-7890"

previous_attributes.ship_to_address.email_address

string | null

required

Example:

"[email protected]"

previous_attributes.bill_to_address

BillToAddress · object

Show child attributes

previous_attributes.bill_to_address.full_name

string | null

required

Example:

"John Doe"

previous_attributes.bill_to_address.address1

string | null

required

Example:

"123 Main St"

previous_attributes.bill_to_address.address2

string | null

required

Example:

"Apt 2"

previous_attributes.bill_to_address.address3

string | null

required

Example:

"Floor 3"

previous_attributes.bill_to_address.city

string | null

required

Example:

"New York"

previous_attributes.bill_to_address.state

string | null

required

Example:

"NY"

previous_attributes.bill_to_address.postal_code

string | null

required

Example:

"10001"

previous_attributes.bill_to_address.country

string | null

required

Example:

"United States"

previous_attributes.earliest_ship_date

string<date-time> | null

The earliest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

previous_attributes.latest_ship_date

string<date-time> | null

The latest date the order can be shipped.

Example:

"2022-10-10T01:02:03Z"

previous_attributes.line_items

CartOrderLineItem · object[]

List of the products included in the order.

Show child attributes

previous_attributes.line_items.line_item_id

string

required

The ID of the line item.

Example:

"line_item_id"

previous_attributes.line_items.product_id

string

required

The ID of the product. Can be passed into the Cart Product endpoint for more details.

previous_attributes.line_items.product_sku

string | null

required

previous_attributes.line_items.parent_product_id

string | null

required

The ID of the product's parent.

previous_attributes.line_items.parent_product_sku

string | null

required

previous_attributes.line_items.quantity

integer

required

Example:

1

previous_attributes.line_items.unit_price

number | null

required

The price of the product in the currency specified by invoice_currency_code.

Example:

10.99

previous_attributes.line_items.discount

number | null

required

The unit amount discounted from the product for this order. This is the amount of discount per unit of the product.

Example:

1.5

previous_attributes.line_items.tax

number | null

required

The unit amount of tax on the product for this order. This is the amount of tax per unit of the product

Example:

0.5

Example:

[
  {
    "line_item_id": "line_item_id",
    "product_id": null,
    "product_sku": null,
    "parent_product_id": null,
    "parent_product_sku": null,
    "quantity": 1,
    "unit_price": 10.99,
    "discount": 1.5,
    "tax": 0.5
  }
]

previous_attributes.shipping_groups

CartOrderShippingGroup · object[]

Sets of line items that will be fulfilled together from the same locations. Only applies in Shopify, as fulfillmentOrders.

Show child attributes

previous_attributes.shipping_groups.shipping_group_id

string

required

The ID of the shipping_group.

Example:

"shipping_group_id"

previous_attributes.shipping_groups.created_date

string<date-time>

required

The date the shipping_group was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.shipping_groups.updated_date

string<date-time>

required

The date the shipping_group was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.shipping_groups.raw_status

string | null

required

The raw status (if available) of the shipping group returned directly from the integration.

Example:

"raw_status"

previous_attributes.shipping_groups.status

enum<string> | null

required

The status of the shipping group.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

previous_attributes.shipping_groups.warehouse_id

string

required

The ID of the warehouse that the shipping group will send from. Subject to change.

Example:

"warehouse_id"

previous_attributes.shipping_groups.line_items

CartOrderShipmentGroupLineItem · object[]

required

List of the products in the shipping group.

Show child attributes

previous_attributes.shipping_groups.line_items.line_item_id

string

required

The ID of the line item in the shipping group.

Example:

"shipping_group_line_item_id"

previous_attributes.shipping_groups.line_items.product_id

string

required

The ID of the product.

previous_attributes.shipping_groups.line_items.product_sku

string | null

required

previous_attributes.shipping_groups.line_items.parent_product_id

string | null

required

The ID of the product's parent.

previous_attributes.shipping_groups.line_items.quantity

integer

required

Example:

0

previous_attributes.shipments

CartOrderShipment · object[]

List of the shipments sent out to the customer.

Show child attributes

previous_attributes.shipments.shipment_id

string

required

The ID of the shipment.

Example:

"shipment_id"

previous_attributes.shipments.raw_status

string | null

required

The raw status (if available) of the shipment returned directly from the integration.

Example:

"raw_status"

previous_attributes.shipments.status

enum<string> | null

required

The status of the shipment.

Available options:

open,

shipped,

delivered,

cancelled,

exception,

on_hold,

other

Example:

"shipped"

previous_attributes.shipments.warehouse_id

string | null

required

The warehouse the shipment was shipped from. Can be passed into the Warehouse endpoint for more details.

Example:

"warehouse_id"

previous_attributes.shipments.shipping_method_id

string | null

required

The ID of the shipping method used for the shipment.

Example:

"shipment_shipping_method_id"

previous_attributes.shipments.shipping_method_name

string | null

required

The name of the shipping method used for the shipment.

Example:

"shipment_shipping_method_name"

previous_attributes.shipments.carrier_id

string | null

required

The ID of the carrier used to ship the shipment.

Example:

"carrier_id"

previous_attributes.shipments.carrier_name

string | null

required

The name of the carrier used to ship the shipment.

Example:

"carrier_name"

previous_attributes.shipments.tracking_number

string | null

required

The tracking number for the shipment.

previous_attributes.shipments.tracking_url

string | null

required

The URL for the tracking number.

Example:

"https://www.example.com/tracking"

previous_attributes.shipments.line_items

CartOrderShipmentLineItem · object[]

required

List of the products listed in the shipment.

Show child attributes

previous_attributes.shipments.line_items.shipment_line_item_id

string

required

The ID of the line item in the shipment.

previous_attributes.shipments.line_items.product_id

string

required

The ID of the product.

previous_attributes.shipments.line_items.product_sku

string | null

required

previous_attributes.shipments.line_items.parent_product_id

string | null

required

The ID of the product's parent.

previous_attributes.shipments.line_items.parent_product_sku

string | null

required

previous_attributes.shipments.line_items.quantity

integer

required

Example:

0

previous_attributes.shipments.shipping_groups

string[]

required

List of the shipping groups included in the shipment. Only applies in Shopify, as fulfillmentOrders.

The ID of the shipping group included in the shipment.

Example:

["sg_id_1", "sg_id_2"]

previous_attributes.shipments.created_date

string<date-time> | null

required

The date the shipment was created.

Example:

"2022-01-01T00:00:00Z"

previous_attributes.shipments.updated_date

string<date-time> | null

required

The date the shipment was last updated.

Example:

"2022-01-02T05:05:05Z"

previous_attributes.external_system_url

string | null

URL link to the order in the external system (WMS/Freight etc).

Example:

"https://example.com/order/123"

previous_attributes.additional_fields

object

Integration-specific fields

Show child attributes

previous_attributes.additional_fields.{key}

any

Example:

{ "key": "value" }

Response

200

Success

Home

How-To Guides

Use Cases

Cart order updated

Body

Response