POST
/
api
/
ext
/
v1
/
collection
/
{collectionId}
/
orders
/
get
curl --request POST \
  --url https://staging-api.covver.io/api/ext/v1/collection/{collectionId}/orders/get \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "companyId": "<string>",
  "filter": {
    "userIds": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "dateRange": {
      "start": "2023-11-07T05:31:56Z",
      "end": "2023-11-07T05:31:56Z"
    }
  }
}'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "orderNumber": "<string>",
      "externalId": "<string>",
      "user": {
        "externalId": "<string>",
        "email": "<string>"
      },
      "orderLineItems": [
        {
          "id": "<string>",
          "title": "<string>",
          "quantity": 123,
          "price": 123,
          "retailPrice": 123,
          "productTitle": "<string>",
          "variantTitle": "<string>",
          "productId": "<string>",
          "variantId": "<string>",
          "image": {
            "url": "<string>",
            "aspectRatio": 123
          },
          "personalizations": {
            "name": {
              "first": "<string>",
              "last": "<string>",
              "firstNameInitials": "<string>",
              "lastNameInitials": "<string>",
              "initials": "<string>",
              "firstPossessive": "<string>"
            },
            "anniversary": {
              "month": 123,
              "monthPadded": "<string>",
              "year": 123,
              "decade": "<string>",
              "years": 123,
              "yearsPadded": "<string>",
              "hundreds": "<string>",
              "zodiac": "Capricorn",
              "ordinal": "<string>",
              "elapsed": "<string>"
            },
            "birth": {
              "month": 123,
              "monthPadded": "<string>",
              "year": 123,
              "decade": "<string>",
              "years": 123,
              "yearsPadded": "<string>",
              "hundreds": "<string>",
              "zodiac": "Capricorn",
              "ordinal": "<string>",
              "elapsed": "<string>"
            },
            "work": {
              "department": "<string>",
              "location": "<string>"
            }
          },
          "sha": "<string>"
        }
      ]
    }
  ],
  "count": 123
}
Date range filter is inclusive of both start and end dates and only filters via the day and not the time of day

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
collectionId
string
required

Body

application/json

Response

200
application/json

Default Response

The response is of type object.