Orders

Get all orders

get
Authorizations
Query parameters
pageinteger · int32Optional

The page number to request (1 based)

Default: 1Example: 1
sizeinteger · int32Optional

The number of results to return in a page

Default: 100Example: 10
personIdstring · uuidOptional

The ID of the person to return orders for

Example: d7d0d906-425f-402f-bde1-39031c67c40b
startDatestring · date-timeOptional

UTC Date-time to filter orders created after (ISO-8601 without timezone)

Example: 2007-12-03T10:15:30
endDatestring · date-timeOptional

UTC Date-time to filter orders created before (ISO-8601 without timezone)

Example: 2007-12-03T10:15:30
Responses
200
OK
application/json
get
GET /api/orders HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "personId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "status": "COMPLETED",
    "orderItems": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "skuId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "iPad Air - Silver, 64GB, WiFi",
        "status": "PROCESSING",
        "shipment": {
          "trackingUrl": "text",
          "trackingCode": "1Z00000000",
          "carrier": "UPS",
          "status": "DELIVERED",
          "trackingHistory": [
            {
              "status": "IN_TRANSIT",
              "timestamp": "2025-07-25T00:36:47.866Z"
            }
          ]
        }
      }
    ]
  }
]

Get an order by ID

get
Authorizations
Path parameters
orderIdstring · uuidRequired
Responses
200
OK
application/json
get
GET /api/orders/{orderId} HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "personId": "d7d0d906-425f-402f-bde1-39031c67c40b",
    "status": "COMPLETED",
    "orderItems": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "skuId": "123e4567-e89b-12d3-a456-426614174000",
        "title": "iPad Air - Silver, 64GB, WiFi",
        "status": "PROCESSING",
        "shipment": {
          "trackingUrl": "text",
          "trackingCode": "1Z00000000",
          "carrier": "UPS",
          "status": "DELIVERED",
          "trackingHistory": [
            {
              "status": "IN_TRANSIT",
              "timestamp": "2025-07-25T00:36:47.866Z"
            }
          ]
        }
      }
    ]
  }
]

Create an order for a specified person

post
Authorizations
Body

Request body

personIdstring · uuidRequired
Responses
200
OK
application/json
post
POST /api/orders HTTP/1.1
Host: apipub.firstbasehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 485

{
  "shippingAddress": {
    "addressLine1": "text",
    "addressLine2": "text",
    "administrativeArea": "text",
    "countryCode": "text",
    "dependentLocality": "text",
    "locality": "text",
    "postalCode": "text",
    "sortingCode": "text",
    "phoneNumber": "text",
    "integrations": {
      "provider": "MERGE",
      "mergeTenant": "US",
      "integrationAddressId": "text"
    }
  },
  "personId": "123e4567-e89b-12d3-a456-426614174000",
  "skus": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "expeditedShippingOption": "EXPEDITED_STANDARD",
      "preferredCondition": "NEW"
    }
  ]
}
[
  {
    "orderId": "123e4567-e89b-12d3-a456-426614174000",
    "itemIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]
PreviousArchiveNextShipments

Last updated