Introduction

SCHEMAS

Introduction

A single schema to push and pull E-Commerce data across connectors.

Supported Connectors

Amazon Seller

BigCommerce

Etsy

Faire

Lightspeed (C-Series)

Magento 2

Marketplacer

Medusa

Salesforce Commerce Cloud

ShipStation

Shopify

Square

Squarespace

Wix

WooCommerce

Customers

A customer represents a customer account with the shop.

Properties

string

phone

string

address

object

city

string

country

string

custom_fields

array [ ]

string

line1

string

line2

string

line3

string

postal_code

string

prefix

string

state

string

company

string

last_name

string

created_at

string

first_name

string

updated_at

string

custom_fields

object [ ]

label

string

name

string

value

string

Example

COPY TO CLIPBOARD

{
  "id": "4d5330e2-aecd-11ec-b909-0242ac120002",
  "name": "Jeff Bezos",
  "email": "jeff@amazon.com",
  "phone": "2405555555",
  "addresses": [
    {
      "id": "1",
      "city": "Seattle",
      "line1": "410 Terry Ave N",
      "line2": "",
      "line3": "",
      "state": "WA",
      "country": "USA",
      "postal_code": "98109"
    }
  ],
  "created_at": "2021-06-23T09:09:34.752Z",
  "updated_at": "2021-06-23T09:10:02.798Z"
}

Locations

Properties

string

name

string

Example

COPY TO CLIPBOARD

{
  "id": "1e50d558-9588-413e-8fca-2cc5a2b2e152",
  "name": "Baltimore, USA"
}

Products

Properties

string

sku

string

cost

number

name

string

slug

string

active

boolean

options

string [ ]

virtual

boolean

categories

object [ ]

string

name

string

created_at

string

image_urls

string [ ]

updated_at

string

description

string

custom_fields

object [ ]

label

string

name

string

value

string

short_description

string

origin_country_code

string

Example

COPY TO CLIPBOARD

{
  "id": "576ba74eec471ff9b01557cc",
  "cost": 17.25,
  "name": "Portable Charger",
  "price": 49.99,
  "active": true,
  "options": [
    "Color",
    "Size"
  ],
  "category": {
    "id": "6e0c51ef-1b66-42a8-ac96-8437da0e9507",
    "name": "Gadgets & Gizmos"
  },
  "location": {
    "id": "1e50d558-9588-413e-8fca-2cc5a2b2e152",
    "name": "Baltimore, USA"
  },
  "variants": [
    {
      "id": "576ba74eec471ff9b01557ccbm",
      "sku": "P001-BM",
      "cost": 17.25,
      "price": 49.99,
      "options": [
        {
          "name": "Color",
          "value": "Black"
        },
        {
          "name": "Size",
          "value": "Medium"
        }
      ],
      "image_urls": [
        "http://example.com/charger2.png"
      ],
      "available_quantity": 5
    },
    {
      "id": "576ba74eec471ff9b01557ccrs",
      "sku": "P001-RS",
      "cost": 17.25,
      "price": 49.99,
      "options": [
        {
          "name": "Color",
          "value": "Red"
        },
        {
          "name": "Size",
          "value": "Small"
        }
      ],
      "image_urls": [
        "http://example.com/charger3.png"
      ],
      "available_quantity": 5
    }
  ],
  "published": true,
  "suppliers": [
    {
      "id": "c62425b1-1adf-4984-8b44-d3b4d9e601ad",
      "name": "Michael & Son"
    }
  ],
  "created_at": "2022-08-01T09:09:34.752Z",
  "image_urls": [
    "http://example.com/charger1.png"
  ],
  "updated_at": "2022-08-01T09:10:02.798Z",
  "description": "Imagine a bunch of awesome tech specs here",
  "short_description": "A Portable USB Charger for humans"
}

Sales Orders

An order is a customer's request to purchase one or more products from a shop.

Properties

string

paid

boolean

tags

string [ ]

phone

string

status

string

carrier

string

cart_id

string

currency

string

store_id

string

subtotal

number

fulfilled

boolean

total_tax

number

created_at

string

line_items

object [ ]

custom_fields

array [ ]

discount_amount

number

string

notes

string

options

array [ ]

product_id

string

product_name

string

quantity

number

sku

string

tax_amount

number

total_price

number

unit_price

number

store_name

string

updated_at

string

customer_id

string

order_notes

string

total_price

number

billing_name

string

order_number

string

tracking_url

string

billing_email

string

billing_phone

string

custom_fields

object [ ]

label

string

name

string

value

string

customer_name

string

shipping_name

string

customer_email

string

payment_method

string

requested_date

string

shipping_email

string

shipping_lines

object [ ]

carrier

string

code

string

custom_fields

array [ ]

discount_amount

number

string

source

string

subtotal

number

total_price

number

total_tax

number

shipping_phone

string

total_discount

number

total_shipping

number

billing_address

object

city

string

country

string

custom_fields

array [ ]

string

line1

string

line2

string

line3

string

postal_code

string

prefix

string

state

string

billing_company

string

delivery_status

string

parent_order_id

string

tracking_number

string

customer_company

string

shipping_address

object

city

string

country

string

custom_fields

array [ ]

string

line1

string

line2

string

line3

string

postal_code

string

prefix

string

state

string

shipping_company

string

transaction_date

string

Example

COPY TO CLIPBOARD

{
  "id": "8a2294e9-4b68-4fb0-a8b3-cd5e5b3f53ad",
  "status": "active",
  "carrier": "UPS",
  "currency": "USD",
  "subtotal": 49.99,
  "fulfilled": true,
  "total_tax": 0,
  "created_at": "2022-08-15T19:16:35Z",
  "line_items": [
    {
      "id": "6355cf19-8364-4782-a527-c3830a8568ab",
      "sku": "P001",
      "quantity": 1,
      "product_id": "576ba74eec471ff9b01557cc",
      "tax_amount": 0,
      "unit_price": 49.99,
      "total_price": 49.99,
      "product_name": "Portable Charger",
      "discount_amount": 0
    }
  ],
  "updated_at": "2022-08-15T19:16:35Z",
  "customer_id": "4d5330e2-aecd-11ec-b909-0242ac120002",
  "total_price": 52.99,
  "order_number": "001",
  "customer_name": "Jeff Bezos",
  "total_discount": 0,
  "total_shipping": 3,
  "billing_address": {
    "id": "1",
    "city": "Seattle",
    "line1": "410 Terry Ave N",
    "line2": "",
    "line3": "",
    "state": "WA",
    "country": "USA",
    "postal_code": "98109"
  },
  "delivery_status": "delivered",
  "shipping_address": {
    "id": "1",
    "city": "Seattle",
    "line1": "410 Terry Ave N",
    "line2": "",
    "line3": "",
    "state": "WA",
    "country": "USA",
    "postal_code": "98109"
  },
  "transaction_date": "2022-08-16T19:16:35Z"
}

Store

Properties

string

url

string

store_name

string

default_currency

string

Example

COPY TO CLIPBOARD

{
  "id": "acd92bf4-5d30-4398-8f77-f5504af1bafc",
  "url": "https://store.hotglue.com",
  "store_name": "hotglue testing store",
  "default_currency": "USD"
}

Suppliers

Properties

string

name

string

Example

COPY TO CLIPBOARD

{
  "id": "c62425b1-1adf-4984-8b44-d3b4d9e601ad",
  "name": "Michael & Son"
}

Introduction

Categories

Customers

Locations

Products

Sales Orders

Store

Suppliers