Skip to main content
POST
/
stores
/
{storeId}
/
orders
Create Order
curl --request POST \
  --url https://api.getredo.com/v2.2/stores/{storeId}/orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "orderId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "lineItems": [
    {
      "id": "<string>",
      "productId": "<string>",
      "title": "<string>",
      "quantity": 500,
      "variantId": "<string>",
      "sku": "<string>",
      "price": 1,
      "imageUrl": "<string>",
      "discount": 1
    }
  ],
  "customer": {
    "id": "<string>",
    "email": "<string>",
    "phoneNumber": "<string>",
    "name": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "shipping": {
    "method": "<string>",
    "cost": 1,
    "address": {
      "address1": "<string>",
      "address2": "<string>",
      "city": "<string>",
      "province": "<string>",
      "country": "<string>",
      "postalCode": "<string>"
    }
  },
  "totalPrice": 1,
  "subtotalPrice": 1,
  "totalTax": 1,
  "totalDiscount": 1,
  "billingAddress": {
    "address1": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "province": "<string>",
    "country": "<string>",
    "postalCode": "<string>"
  },
  "tags": [
    "<string>"
  ],
  "currencyCode": "<string>",
  "locationId": "loc_4d8e1a2b3c"
}
'
{
  "orderId": "<string>",
  "externalOrderId": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
storeId
string
required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Body

application/json

Request body for creating an order.

​
orderId
string
required

Unique identifier for the order.

​
createdAt
string<date-time>
required

ISO 8601 date string for when the order was created.

​
lineItems
object[]
required

List of line items in the order.

Minimum array length: 1
​
customer
object

Customer information.

​
shipping
object

Shipping information.

​
totalPrice
number | null

Total order price including tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

Required range: x >= 0
​
subtotalPrice
number | null

Subtotal price excluding tax and shipping, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

Required range: x >= 0
​
totalTax
number | null

Total tax amount, as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

Required range: x >= 0
​
totalDiscount
number | null

Total discount amount applied to the order (e.g. coupon codes, promotions), as a decimal amount in the order's currency (e.g. $79.99, not 7999 cents).

Required range: x >= 0
​
billingAddress
object

Billing address.

​
tags
string[] | null

Optional tags associated with the order.

​
currencyCode
string | null

Currency code from the ISO 4217 standard (e.g., USD, EUR, GBP).

​
locationId
string | null

Optional. Pin this order to a specific fulfillment location. Must be a location id (loc_...) returned by GET /inventory-levels — either one of your own warehouses or a location at a linked 3PL fulfillment service. When provided, the fulfillment group's origin address is sourced from the location row. Omit to use your team's default origin address.

Example:

"loc_4d8e1a2b3c"

Response

Success

Successful order creation response.

​
orderId
string
required

Internal Redo order ID.

​
externalOrderId
string
required

Original external order ID provided in the request.