Skip to main content

Order Details

Returns full details for a given order, including status, recipient address, card, pricing, and delivery information. Most commonly used to check order status or delivery confirmation status (if delivery confirmation was added to the order).

Query Parameters
id integer REQUIRED

Order id

Responses
200

Order details

Schema OPTIONAL
httpCode integer OPTIONAL
status string OPTIONAL
order object OPTIONAL
id int64 OPTIONAL
basket_id int64 OPTIONAL
for_free boolean OPTIONAL
date_created int64 OPTIONAL
message string OPTIONAL
message_orig string OPTIONAL
font string OPTIONAL
fontInfo object OPTIONAL
id string OPTIONAL
label string OPTIONAL
font_file string OPTIONAL
image string OPTIONAL
sort string OPTIONAL
on_custom string OPTIONAL
font_eot_file string OPTIONAL
font_name string OPTIONAL
visible string OPTIONAL
user_group_id string OPTIONAL
address_from object OPTIONAL

An address

id int32 OPTIONAL
type string OPTIONAL

Possible values: [user_from, user_to, order_from, order_to]

user_id integer OPTIONAL
order_id integer OPTIONAL
name string OPTIONAL
business_name string OPTIONAL
address1 address OPTIONAL
address2 string OPTIONAL
city string OPTIONAL
state string OPTIONAL
zip integer OPTIONAL
date_created date-time OPTIONAL
date_updated date-time OPTIONAL
basket_id integer OPTIONAL
country string OPTIONAL
delivery_cost float OPTIONAL
country_id integer OPTIONAL
first_name string OPTIONAL
last_name string OPTIONAL
birthday date OPTIONAL
anniversary date OPTIONAL
address_id integer OPTIONAL
ext_id integer OPTIONAL
country_obj object OPTIONAL
id integer OPTIONAL
name string OPTIONAL
delivery_cost number OPTIONAL
address_to object OPTIONAL
price int64 OPTIONAL
used_credit int64 OPTIONAL
payed int64 OPTIONAL
status string OPTIONAL
date_day string OPTIONAL
date_month string OPTIONAL
date_year string OPTIONAL
date_send date OPTIONAL
card_category_name string OPTIONAL
card_name string OPTIONAL
card_cover string OPTIONAL
multiaddress int64 OPTIONAL
is_bulk int64 OPTIONAL
delivery_cost int64 OPTIONAL
notes string OPTIONAL
test_mode int64 OPTIONAL
tax string OPTIONAL
refund_status int64 OPTIONAL
wishes string OPTIONAL

wishes as part of the signature in the letter

signature_id integer OPTIONAL

signature ID for wishes block

signature_preview string OPTIONAL

URL

signature2_id integer OPTIONAL

signature ID for main block

signature2_preview string OPTIONAL

URL

card object OPTIONAL
id integer OPTIONAL
name string OPTIONAL
cover string OPTIONAL
price integer OPTIONAL
price_orig integer OPTIONAL
category_id integer OPTIONAL
quantity integer OPTIONAL
delivery_cost integer OPTIONAL
card_dimensions object OPTIONAL
closed_width string OPTIONAL
closed_height string OPTIONAL
margin_top string OPTIONAL
margin_right string OPTIONAL
margin_bottom string OPTIONAL
margin_left string OPTIONAL
font_size string OPTIONAL
half_inside string OPTIONAL
quantity integer OPTIONAL
childs object[] OPTIONAL

NOTE: List only 5 child orders, use list_childs request to get all child orders

id integer OPTIONAL
message string OPTIONAL
address_to object OPTIONAL

An address

id int32 OPTIONAL
type string OPTIONAL

Possible values: [user_from, user_to, order_from, order_to]

user_id integer OPTIONAL
order_id integer OPTIONAL
name string OPTIONAL
business_name string OPTIONAL
address1 address OPTIONAL
address2 string OPTIONAL
city string OPTIONAL
state string OPTIONAL
zip integer OPTIONAL
date_created date-time OPTIONAL
date_updated date-time OPTIONAL
basket_id integer OPTIONAL
country string OPTIONAL
delivery_cost float OPTIONAL
country_id integer OPTIONAL
first_name string OPTIONAL
last_name string OPTIONAL
birthday date OPTIONAL
anniversary date OPTIONAL
address_id integer OPTIONAL
ext_id integer OPTIONAL
country_obj object OPTIONAL
id integer OPTIONAL
name string OPTIONAL
delivery_cost number OPTIONAL
status string OPTIONAL
delivery_cost integer OPTIONAL
price number OPTIONAL
used_credit number OPTIONAL
tax string OPTIONAL
address_from object OPTIONAL

An address

id int32 OPTIONAL
type string OPTIONAL

Possible values: [user_from, user_to, order_from, order_to]

user_id integer OPTIONAL
order_id integer OPTIONAL
name string OPTIONAL
business_name string OPTIONAL
address1 address OPTIONAL
address2 string OPTIONAL
city string OPTIONAL
state string OPTIONAL
zip integer OPTIONAL
date_created date-time OPTIONAL
date_updated date-time OPTIONAL
basket_id integer OPTIONAL
country string OPTIONAL
delivery_cost float OPTIONAL
country_id integer OPTIONAL
first_name string OPTIONAL
last_name string OPTIONAL
birthday date OPTIONAL
anniversary date OPTIONAL
address_id integer OPTIONAL
ext_id integer OPTIONAL
country_obj object OPTIONAL
id integer OPTIONAL
name string OPTIONAL
delivery_cost number OPTIONAL
401

UNAUTHORIZED

Schema OPTIONAL
httpCode integer OPTIONAL

Possible values: [401]

Http status code

status string OPTIONAL

Possible values: [error]

message string OPTIONAL
404

not found

Schema OPTIONAL
httpCode integer OPTIONAL
error string OPTIONAL

Possible values: [order not found]

error description

422

no order id

Schema OPTIONAL
httpCode integer OPTIONAL
error string OPTIONAL

Possible values: [request error]

error description