v1

latestOpenAPI 3.1.02026-07-14460151.1 KB

Create a order

Create a new order. If your order includes products that ship from multiple facilities, each facility’s products will be processed as a separate shipment within the overarching order.

post/v2/orders

Headers

Idempotency-Keystring

Request body

first_namestring required

last_namestring required

companystring

phone_numberstring

Required for int'l orders

emailstring

Required for int'l orders

address1string required

address2string

citystring required

statestring required

2 character code for USA states.

zip_codestring required

countrystring required

2 character country code. (eg: US)

notecard_messagestring

notecard_logostring binary

notecard_urlstring

The notecard URL, if defined, will be used rather than the notecard message and logo

shopify_order_idstring

Utilize this field as your external order reference

billing_namestring

billing_address_1string

billing_address_2string

billing_zip_codestring

billing_citystring

billing_statestring

skip_address_validationboolean

Utilize this field to override our address verification

Response

201

Example response

{
  "data": {
    "id": 2,
    "first_name": "firstname",
    "last_name": "lastname",
    "company": "company",
    "phone": "0000000000",
    "email": "email@company.com",
    "address1": "line 1",
    "address2": "line 2",
    "city": "city",
    "state": "state",
    "zip_code": "000000",
    "country": "country",
    "status": "status",
    "created_at": "2021-08-11T19:58:29+00:00",
    "notecard": {
      "id": 1,
      "name": "test",
      "message": "content",
      "logo": {
        "id": 1,
        "src": "https://corporatemerch.com/image1.png",
        "created_at": "2025-01-26T05:43:03+00:00"
      }
    },
    "shipment_cost": {
      "products": "0",
      "notecard": "1.75",
      "shipping": "8",
      "tax": "0",
      "duty": "0",
      "other": "0",
      "total_cost": "9.75"
    },
    "shipments": [
      {
        "id": 1,
        "order_id": 2,
        "status": "status",
        "created_at": "2025-01-18T21:39:27.000000Z",
        "products": [
          {
            "id": 100,
            "variant_id": 200,
            "quantity": 1,
            "unit_price": "10.00"
          }
        ]
      }
    ]
  }
}