Skip to content

Import sales

POST
/sales/upload/

A sale represents a single line item (row) in a transaction with a customer.

Authorizations

bearerAuth

API Key authentication. Use format: Bearer <YOUR_TOKEN>

Type
HTTP (bearer)

Request Body

application/json
JSON
{
"sales": [
{
"sale_external_id": "1000",
"sale_date": "2017-12-01T13:11:23Z",
"sale_customer_id": "A501",
"sale_phone_number": "+358401234567",
"sale_email": "customer@example.com",
"sale_currency": "USD",
"sale_discount": 0,
"sale_exchange_rate": 1.112,
"sale_payment_method": "Credit Card",
"sale_shipping": 500,
"sale_coupon_codes": [
[
"SUMMER2024",
"FREESHIP"
]
],
"sale_shipping_method": "Express Delivery",
"sale_shipping_in_currency": 600,
"sale_shop_id": "1",
"sale_state": "COMPLETE",
"sale_total": 5160,
"tags": [
[
"online",
"promotion"
]
],
"external_id": "1000-1",
"product_id": "SKU0435",
"product_sku": "SKU-123456",
"quantity": 1,
"unit_price": 1200,
"discount": 200,
"total": 1200,
"unit_price_in_currency": 2080
}
]
}

Responses

Import scheduled successfully

application/json
JSON
{
"run_id": "run_xyz789"
}