v1

latestOpenAPI 3.0.02026-07-26868170.3 KB

Sales data

Edit an order/cart

Edit an entire order or an abandoned cart with its custom fields.

patch/data/v3/orders/{id}

Path parameters

idstring required

Order's external identifier.

Request body

contact_idstring

store_external_idstring

ordered_atstring

When the order was purchased (local timezone).

discount_amountnumber

shipping_amountnumber

total_pricenumber

tax_amountnumber

sales_personstring

completedboolean

Order is purchased or not

currencystring

Example request

{
  "contact_id": "jdoe@email.com",
  "store_external_id": "ext_madeleine",
  "ordered_at": "2018-01-12 15:00:00",
  "discount_amount": 0.25,
  "shipping_amount": 0.75,
  "total_price": 1.55,
  "tax_amount": 0.55,
  "sales_person": "John Doe",
  "currency": "EUR",
  "products": [
    {
      "product_id": "10",
      "unit_price": "25",
      "quantity": 2,
      "discount_amount": 0,
      "tax_amount": 0,
      "currency": "EUR",
      "total_line_amount": "50"
    }
  ],
  "custom_fields": [
    {
      "name": "foo",
      "value": "bar"
    },
    {
      "name": "foo2",
      "value": "bar2"
    }
  ]
}

Response

Order data.