Get an order - Lumaprints API

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 *****************

Path Params

orderNumber

number

required

The order number of the order to retrieve.

Example:

1000000000

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Order retrieved successfully.

application/json

Body

orderNumber

integer

required

externalId

string

required

storeId

integer

required

orderDate

string

required

email

null

optional

shippingMethod

string

required

productionTime

string

required

discountTotal

integer

required

shippingTotal

number

required

taxTotal

number

required

subTotal

number

required

orderTotal

number

required

orderStatus

string

required

recipient

object

required

firstName

string

required

lastName

string

required

company

null

required

addressLine1

string

required

addressLine2

string | null

optional

city

string

required

state

string

required

zipCode

string

required

country

string

required

phone

string | null

optional

orderItems

array [object {8}]

required

subcategoryId

integer

required

externalItemId

string

required

quantity

integer

required

width

integer

required

height

integer

required

file

object

required

itemCostTotal

number

required

orderItemOptions

array [object {2}]

required

Example

{
  "orderNumber": "10000000794",
  "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,
      "externalItemId": "1",
      "quantity": 1,
      "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"
        }
      ]
    }
  ]
}

🟠404Order not found.