Our API is currently in open beta, if you encounter any issues or have a suggestion, please email us at [email protected]. Your insights are invaluable to us.

Lumaprints API

Submit a new order.

Sandbox

POST

https://us.api-sandbox.lumaprints.com/api/v1/orders

Order

Submit an order for fulfillment. If everthing is good with the data provided, you will be provided an order number. Submitted orders does not reflect instantly in your account. It might take a couple of minutes because submitted orders are processed through a queue.

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

Body Params application/json

externalId

string <string>

required

The external id or order number of the order.

>= 1 characters<= 191 characters

Example:

186898732

storeId

number

required

The store id to create the order under.

Example:

818

shippingMethod

enum<string> <string>

optional

The shipping method to use for the order. If not provided, the default (cheapest) shipping method will be used.

>= 1 characters<= 191 characters

Allowed values:

defaultpickupgroundground_economy2_dayovernightusps_ground_advantageusps_priority_mailusps_first_class_mail_internationalusps_priority_mail_internationalusps_priority_mail_express_internationalfreight

Default:

default

Example:

overnight

productionTime

enum<string> <string>

optional

The production time to use for the order.

>= 1 characters<= 191 characters

Allowed values:

regularnextdaysameday

Default:

regular

Example:

regular

specialInstructions

string | null

optional

Special instructions for the order.

>= 1 characters<= 1024 characters

Example:

This is a special order.

printouts

array[string <uri>] | null

optional

Printouts to include in the order. Maximum of 3 printouts. URLs must be publicly available.

<= 3 items

recipient

allOf {1}

required

The recipient of the order.

Example:

{"firstName":"John","lastName":"Smith","addressLine1":"955 E Ball Rd.","addressLine2":"","city":"Anaheim","state":"CA","zipCode":"92805","country":"US","phone":"8003806038"}

object (RecipientDto)

optional

orderItems

array[object (OrderItemsDto) {8}]

required

The order items of the order.

Example:

[{"externalItemId":"123456789","subcategoryId":103001,"quantity":1,"width":8,"height":10,"file":{"imageUrl":"https://www.example.com/image.jpg"},"orderItemOptions":[11,51,23],"solidColorHexCode":null}]

subcategoryId

number

required

The subcategory of the order item.

Example:

101001

externalItemId

string <string>

required

The line item id of the order item.

Example:

quantity

number

required

The quantity of the order item.

Example:

width

number

required

The width of the order item.

Example:

height

number

required

The height of the order item.

Example:

file

object

required

Example:

{"imageUrl":"https://www.example.com/image.jpg","saveImage":true}

orderItemOptions

array[number]

required

The ID of options of the order item. If no option/s is provided, the default options will be used.

Example:

[1, 11, 21]

solidColorHexCode

string <string>

optional

The hex color code of solid color wrap in #xxxxxx format. Only needed if you provided option id 3 (Solid Color Wrap) in order item options. If no hex color is provided, black (#000000) default color will be used.

Example:

#12aaeb

Example

{
  "externalId": "186898732",
  "storeId": 818,
  "shippingMethod": "default",
  "productionTime": "regular",
  "specialInstructions": "This is a special order.",
  "printouts": [
    "https://www.example.com/printout1.jpg",
    "https://www.example.com/printout2.jpg",
    "https://www.example.com/printout3.jpg"
  ],
  "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": [
    {
      "externalItemId": "123456789",
      "subcategoryId": 103001,
      "quantity": 1,
      "width": 8,
      "height": 10,
      "file": {
        "imageUrl": "https://www.example.com/image.jpg"
      },
      "orderItemOptions": [
        11,
        51,
        23
      ],
      "solidColorHexCode": null
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://us.api-sandbox.lumaprints.com/api/v1/orders' \
--header 'Content-Type: application/json' \
--data-raw '{
    "externalId": "186898732",
    "storeId": 818,
    "shippingMethod": "default",
    "productionTime": "regular",
    "specialInstructions": "This is a special order.",
    "printouts": [
        "https://www.example.com/printout1.jpg",
        "https://www.example.com/printout2.jpg",
        "https://www.example.com/printout3.jpg"
    ],
    "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": [
        {
            "externalItemId": "123456789",
            "subcategoryId": 103001,
            "quantity": 1,
            "width": 8,
            "height": 10,
            "file": {
                "imageUrl": "https://www.example.com/image.jpg"
            },
            "orderItemOptions": [
                11,
                51,
                23
            ],
            "solidColorHexCode": null
        }
    ]
}'

Responses

🟢201Order has been successfully submitted.

application/json

Body

message

string

required

orderNumber

integer

required

Example

{
  "message": "The preliminary checks for the order submission were successful. It has now been placed in the queue for processing.",
  "orderNumber": 10000001440
}

🟠400Bad Request

🟠406Not Acceptable

Modified at 2024-09-06 18:32:39

Get multiple orders

Check image