Get multiple orders - Lumaprints API

Retrieve a list of orders with their details.

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

Query Params

storeId

number

required

The store id of the orders to retrieve.

Example:

1000

page

number

optional

The page number of the orders to retrieve.

Example:

orderDateStart

string

optional

The starting order date of orders to retrieve.

Example:

2023-09-01

orderDateEnd

string

optional

The ending order date of orders to retrieve.

Example:

2023-09-30

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Order retrieved successfully.

application/json

Body

orders

array [object {15}]

required

orderNumber

integer

required

externalId

string

required

storeId

integer

required

orderDate

string

required

null

optional

shippingMethod

string

required

productionTime

string

required

discountTotal

number

required

shippingTotal

number

required

taxTotal

number

required

subTotal

number

required

orderTotal

number

required

orderStatus

string

required

recipient

object

required

orderItems

array [object {8}]

required

totalOrders

integer

required

currentPage

integer

required

totalPages

integer

required

Example

{
  "orders": [
    {
      "orderNumber": "10000000001",
      "externalId": "186898732",
      "storeId": "818",
      "orderDate": "2023-08-30T10:19:20.000Z",
      "shippingMethod": "default",
      "productionTime": "regular",
      "discountTotal": 5.99,
      "shippingTotal": 11.99,
      "taxTotal": 1.29,
      "subTotal": 29.99,
      "orderTotal": 37.28,
      "orderStatus": "Awaiting Fulfillment",
      "recipient": {
        "firstName": "John",
        "lastName": "Smith",
        "addressLine1": "123 Main St.",
        "addressLine2": "Apt. 123",
        "city": "New York",
        "state": "NY",
        "zipCode": "10001",
        "country": "US",
        "phone": "123-456-7890",
        "company": "ABC Company"
      },
      "orderItems": [
        {
          "subcategoryId": 101001,
          "width": 8,
          "height": 10,
          "file": {
            "imageUrl": "https://www.example.com/image.jpg"
          },
          "itemCostTotal": 29.99,
          "orderItemOptions": [
            {
              "optionId": 1,
              "optionName": "Image Wrap"
            },
            {
              "optionId": 4,
              "optionName": "Sawtooth Hanger installed"
            },
            {
              "optionId": 9,
              "optionName": "None"
            }
          ]
        }
      ]
    }
  ],
  "totalOrders": 1,
  "currentPage": 1,
  "totalPages": 1
}

🟠404No orders found

🟠400Bad Request