Get Order

GET 
/commerce/orders/:orderId

Get order for a specified connection

Request

Path Parameters

orderId stringrequired

The order ID of the order item

Query Parameters

credentialId stringrequired

The ID of the credential.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

order

object

id string

remoteId string

orderStatus string

lineItems

object[]

Array [

quantity integer

Default value: 0

productId string

price string

unitCost string

currency string

variantId string

title string

sku string

]

orderNumber string

paymentStatus string

customer

object

customerId string

firstName string

lastName string

phone string

email string

currency string

totalPrice string

totalDiscount string

totalShipping string

totalTax string

fulfillmentStatus string

remoteCreatedAt string

remoteUpdatedAt string

remoteDeleted boolean

Default value: true

createdAt string

updatedAt string

Example (from schema)

{
  "order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "2191357149242",
    "orderStatus": "Active",
    "lineItems": [
      {
        "quantity": 1,
        "productId": "4463254208570",
        "price": "1000.00",
        "unitCost": "",
        "currency": "USD",
        "variantId": "31586061353018",
        "title": "T-Shirt",
        "sku": "shirt-01"
      }
    ],
    "orderNumber": "1001",
    "paymentStatus": "Paid",
    "customer": {
      "customerId": "3046096732218",
      "firstName": "Chase",
      "lastName": "Red",
      "phone": "",
      "email": "chasered@runalloy.com"
    },
    "currency": "USD",
    "totalPrice": "1000.00",
    "totalDiscount": "0.00",
    "totalShipping": "0.00",
    "totalTax": "0.00",
    "fulfillmentStatus": "unfulfilled",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

Result

{
  "order": {
    "id": "00000000-0000-0000-0000-000000000000",
    "remoteId": "2191357149242",
    "orderStatus": "Active",
    "lineItems": [
      {
        "quantity": 1,
        "productId": "4463254208570",
        "price": "1000.00",
        "unitCost": "",
        "currency": "USD",
        "variantId": "31586061353018",
        "title": "T-Shirt",
        "sku": "shirt-01"
      }
    ],
    "orderNumber": "1001",
    "paymentStatus": "Paid",
    "customer": {
      "customerId": "3046096732218",
      "firstName": "Chase",
      "lastName": "Red",
      "phone": "",
      "email": "chasered@runalloy.com"
    },
    "currency": "USD",
    "totalPrice": "1000.00",
    "totalDiscount": "0.00",
    "totalShipping": "0.00",
    "totalTax": "0.00",
    "fulfillmentStatus": "unfulfilled",
    "remoteCreatedAt": "2023-11-19T17:00:17.000Z",
    "remoteUpdatedAt": "2023-11-19T17:00:17.000Z",
    "remoteDeleted": false,
    "createdAt": "2024-02-22T11:17:53.264Z",
    "updatedAt": "2024-02-22T13:54:03.445Z"
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...