Example payloads
Customers
{
"customers": [
{
"id": "cust_1",
"first_name": "John",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": "+15558920591",
"tags": ["tag_1", "tag_2"],
"birthday": {
"year": 1993,
"month": 5,
"day": 15
},
"default_address": {
"address_1": "15 E 4th Ave",
"address_2": "Apt 5B",
"city": "New York",
"province": "NY",
"postal_code": "10003",
"country": "US"
},
"custom_fields": [
{
"key": "custom_field_1",
"values": ["value_1"]
}
],
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z"
},
{
"id": "cust_2",
"first_name": "Jane",
"last_name": "Doe",
"email_address": "[email protected]",
"phone_number": null,
"tags": ["tag_1", "tag_3"],
"birthday": {
"year": null,
"month": 8,
"day": 20
},
"default_address": {
"address_1": "20 W 34th St",
"address_2": null,
"city": "New York",
"province": "NY",
"postal_code": "10001",
"country": "US"
},
"custom_fields": [
{
"key": "custom_field_2",
"values": ["value_2"]
}
],
"created_at": "2019-01-01T00:00:00Z",
"updated_at": "2019-01-01T00:00:00Z"
}
]
}
Products
{
"products": [
{
"id": "prod_1",
"sku": "TS01942",
"type": ["tops"],
"vendor": "Acme Co",
"title": "Best T-Shirt Ever",
"description_html": "<p>Softest t-shirt you've ever worn.</p>",
"tags": ["best-seller", "summer"],
"url": "http://www.example.com/products/t-shirt-prod_1",
"available_for_sale": true,
"image_id": "1",
"media": [
{
"id": "1",
"src": "http://www.example.com/products/t-shirt-prod_1.jpg",
"alt": "Best T-Shirt Ever"
},
{
"id": "2",
"src": "http://www.example.com/products/t-shirt-prod_1-back.jpg",
"alt": "Best T-Shirt Ever - Back"
}
],
"created_at": "2016-01-01T00:00:00Z",
"updated_at": "2016-01-01T00:00:00Z"
},
{
"id": "prod_2",
"sku": "TS01943",
"type": ["tops"],
"vendor": "Acme Co",
"title": "Second Best T-Shirt Ever",
"description_html": "<p>Second softest t-shirt you've ever worn.</p>",
"tags": ["summer"],
"url": "http://www.example.com/products/t-shirt-prod_2",
"available_for_sale": true,
"created_at": "2016-01-01T00:00:00Z",
"updated_at": "2016-01-01T00:00:00Z"
}
]
}
Product variants
{
"productVariants": [
{
"id": "var_1",
"sku": "TS01942BKS",
"type": ["tops"],
"vendor": "Acme Co",
"title": "Best T-Shirt Ever - Black - Small",
"current_price": {
"amount": 19999,
"currency": "USD",
"precision": 2
},
"compare_at_price": {
"amount": 24999,
"currency": "USD",
"precision": 2
},
"product_id": "prod_1",
"options": [
{
"key": "color",
"values": ["black"]
},
{
"key": "size",
"values": ["s"]
}
],
"created_at": "2017-01-01T00:00:00Z",
"updated_at": "2017-01-01T00:00:00Z",
"image_id": "2"
},
{
"id": "var_2",
"sku": "TS01942WHS",
"type": ["tops"],
"vendor": "Acme Co",
"title": "Best T-Shirt Ever - White - Small",
"current_price": {
"amount": 19999,
"currency": "USD",
"precision": 2
},
"compare_at_price": {
"amount": 24999,
"currency": "USD",
"precision": 2
},
"product_id": "prod_1",
"options": [
{
"key": "color",
"values": ["white"]
},
{
"key": "size",
"values": ["s"]
}
],
"created_at": "2017-01-01T00:00:00Z",
"updated_at": "2017-01-01T00:00:00Z",
"image_id": "1"
}
]
}
Locations
{
"locations": [
{
"id": "loc_1",
"name": "SoHo",
"type": "POS",
"address": {
"name": "SoHo",
"address_1": "123 Mulberry St",
"city": "New York",
"province": "NY",
"postal_code": "10013",
"country": "US"
},
"created_at": "2018-01-01T00:00:00Z",
"updated_at": "2018-01-01T00:00:00Z"
},
{
"id": "loc_2",
"name": "Website",
"type": "WEB",
"created_at": "2018-01-01T00:00:00Z",
"updated_at": "2018-01-01T00:00:00Z"
}
]
}
Users
{
"users": [
{
"id": "usr_1",
"first_name": "Sarah",
"last_name": "Lee",
"email_address": "[email protected]",
"created_at": "2014-07-15T22:00:00Z",
"updated_at": "2014-07-15T22:00:00Z"
},
{
"id": "usr_2",
"first_name": "Jane",
"last_name": "Doe",
"email_address": "[email protected]",
"created_at": "2014-07-15T22:00:00Z",
"updated_at": "2014-07-15T22:00:00Z"
}
]
}
Orders
{
"orders": [
{
"id": "ord_1",
"number": "8502038521",
"channel": {
"id": "POS",
"type": "POS"
},
"customer_id": "cust_1",
"location_id": "loc_1",
"currency": "USD",
"tags": ["summer-sale"],
"discount_codes": ["SUMMER10"],
"processed_by_user_id": "usr_1",
"subtotal_amount": {
"amount": 39998,
"precision": 2,
"currency": "USD"
},
"total_tax_amount": {
"amount": 2520,
"precision": 2,
"currency": "USD"
},
"total_shipping_amount": {
"amount": 0,
"precision": 2,
"currency": "USD"
},
"total_discount_amount": {
"amount": 13999,
"precision": 2,
"currency": "USD"
},
"total_amount": {
"amount": 28519,
"precision": 2,
"currency": "USD"
},
"processed_at": "2018-06-01T12:00:00Z",
"cancelled_at": null,
"created_at": "2018-06-01T12:00:00Z",
"updated_at": "2018-06-01T12:00:00Z"
}
]
}
Order items
{
"orders": [
{
"id": "ord_1",
"number": "8502038521",
"channel": {
"id": "POS",
"type": "POS"
},
"customer_id": "cust_1",
"location_id": "loc_1",
"currency": "USD",
"tags": ["summer-sale"],
"discount_codes": ["SUMMER10"],
"processed_by_user_id": "usr_1",
"subtotal_amount": {
"amount": 39998,
"precision": 2,
"currency": "USD"
},
"total_tax_amount": {
"amount": 2520,
"precision": 2,
"currency": "USD"
},
"total_shipping_amount": {
"amount": 0,
"precision": 2,
"currency": "USD"
},
"total_discount_amount": {
"amount": 13999,
"precision": 2,
"currency": "USD"
},
"total_amount": {
"amount": 28519,
"precision": 2,
"currency": "USD"
},
"processed_at": "2018-06-01T12:00:00Z",
"cancelled_at": null,
"created_at": "2018-06-01T12:00:00Z",
"updated_at": "2018-06-01T12:00:00Z"
}
]
}
Refunds
{
"refunds": [
{
"id": "rfd_1",
"product_id": "prod_1",
"product_variant_id": "var_1",
"original_order_id": "ord_1",
"original_order_item_id": "itm_1",
"quantity": 1,
"subtotal_amount": {
"amount": 19999,
"precision": 2,
"currency": "USD"
},
"total_tax_amount": {
"amount": 1260,
"precision": 2,
"currency": "USD"
},
"processed_at": "2018-06-02T12:00:00Z",
"created_at": "2018-06-02T12:00:00Z",
"updated_at": "2018-06-02T12:00:00Z"
}
]
}
Updated 6 months ago