API Request Examples - Create a Storefront, Order Group, Order...

Below you will find some example payloads for when creating new orders.

Create a new Order (/v2/orders/createorder)

{
  "orderNumber": "testorder1",
  "orderKey": "testorder1",
  "orderStatus": "awaiting_shipment",
  "customerEmail": "[email protected]",
  "billTo": {
    "name": "John Doe",
    "company": "CoolCompany",
    "street1": "Street 1",
    "street2": "",
    "street3": "",
    "city": "New York",
    "state": "NY",
    "postalCode": "78544",
    "phone": "",
    "country": "US"
  },
  "shipTo": {
    "name": "John Doe",
    "company": "CoolCompany",
    "street1": "Street 1",
    "street2": "",
    "street3": "",
    "city": "New York",
    "state": "NY",
    "postalCode": "78544",
    "phone": "",
    "country": "US"
  },
  "items": [
    {
      "lineItemKey": "testorder1-1",
      "sku": "EXAMPLE_SKU",
      "name": "Super Cool Item",
      "quantity": 2,
      "unitPrice": 15,
      "taxAmount": 0,
      "shippingAmount": 0,
      "adjustment": false,
      "weight": {
        "value": 0,
        "units": "pounds"
      }
    },
    {
      "lineItemKey": "testorder1-2",
      "sku": "DISCOUNT 50%",
      "name": "DISCOUNT 50%",
      "quantity": 10,
      "unitPrice": -7.45,
      "taxAmount": 0,
      "shippingAmount": 0,
      "adjustment": true,
      "weight": {
        "value": 0,
        "units": "pounds"
      }
    }
  ],
  "amountPaid": 7.45,
  "shippingAmount": 2,
  "taxAmount": 0,
  "customerNotes": "",
  "requestedShippingService": "UPS_2NDAYAIR",
  "weight": {
    "value": 0,
    "units": "pounds"
  },
  "orderGroupId": "_ORDER_GROUP_ID",
  "storefrontId": "_STOREFRONT_ID_"
}

Create a new Order Group

{
  "name": "Test Order Group",
  "companyName": "",
  "phone": "",
  "publicEmail": "",
  "website": "",
  "storefrontId": "_STOREFRONT_ID_"
}

Create a new Storefront

{
  "name": "Test Storefront 1",
  "brandId": "_BRAND_ID_",
  "warehouseId": "_WAREHOUSE_ID_"
}