Data Feeds

Order Feed

This section will describe the strcuture and format required for a custom order feed.

Order Data Feed:

The table below describes the required fields and values. An example JSON is shown below this information.

Field	Type	Description	Required
id	String	The order ID	Yes
checkout_token	String	Token generated when order is created. This token need to link to the customer’s actions captured by Shopbox	Yes
customer_id	String	The customer’s ID	Yes
total_price	String	The order’s total price – including discounts, sales and shipping.	Yes
currency	String	The ISO 4217 code for the currency that the purchase was made in.	Yes
created_at	String	ISO 8601 formatted datetime of when the order was created.	Yes
updated_at	String	ISO 8601 formatted datetime of when the order was updated.	Yes
cancel_reason	String	The reason for cancelling the order.	Yes
shipping_price	String	The price of shipping the order.	Yes
fulfillment_status	String	The order’s fulfilment status.	Yes
discounts	String	The discount codes and information used in this purchase. These are overall discounts, not product specific ones. Fields below show more information.	Yes
discounts.code	String	The discount code used.	Yes
discounts.amount	String	The amount that was discounted.	Yes
discounts.type	String	The type of discount, e.g. percent.	Yes
line_items	String	A list of products with price and discount information. See fields below.	Yes
line_items.product_id	String	The product’s ID which matches the ID found in the product feed.	Yes
line_items.quantity	String	The quantity of that product that was purchased.	Yes
line_items.price	String	The price of the product.	Yes
line_items.regular_price	String	The price of the product before sale or discount was applied.	Yes
line_items.discounts.code	String	The discount code that was used for this product. It applies on a per product basis.	Yes
line_items.discounts.amount	String	The discount amount that was used for this product. It applies on a per product basis.	Yes
line_items.discounts.type	String	The discount type that was used for this product. It applies on a per product basis.	Yes

{
  "id": "ord123",
  "checkout_token": "5F2Fsgfgklkfgo",
  "customer_id": "cust1234",
  "total_price": "431.98",
  "currency": "EUR",
  "created_at": "2020-11-10T19:00:00-05:00",
  "updated_at": "2020-11-12T13:00:00-05:00",
  "cancel_reason": null,
  "shipping_price": "12.00",
  "fulfillment_status": "complete",
  "discounts": [
    {
      "code": "blackfriday02",
      "amount": "40.00",
      "type": "percent"
    }
  ],
  "line_items": [
    {
      "product_id": "inano123456",
      "quantity": 2,
      "price": "199.99",
      "regular_price": "250.00",
      "discounts": [
        {
          "code": "appledisc01",
          "type": "flat",
          "amount": "20.00"
        }
      ]
    },
    {
      "product_id": "screen98765",
      "quantity": 1,
      "price": "100.00",
      "regular_price": "120.00",
      "discounts": null
    }
  ]
}

SFTP Instructions:

For SFTP instruction please contact you customer success agent or alternatively email [email protected]

Order Feed

# Order Data Feed:

# SFTP Instructions:

Order Data Feed:

SFTP Instructions: