Skip to main content

Retrieve a cart by id

Retrieve a cart by id.

Authorizations:Token, JWT
Query Parameters
id
required
integer

Responses

200Cart resource
Response schema:
Cart resource
mobile_orderboolean
mailchimp_store_idstring
selected_multi_currencystring or null
selected_multi_currency_ratenumber
idinteger>= 0
totalnumber
sub_totalnumber
emailstring
itemsArray of objects
Array
vendor_idinteger
variantinteger
idinteger>= 0
product_idinteger>= 0
skustring
update_datestring
namestring
pricenumber
item_net_pricenumber
discounted_subtotalnumber
amountinteger
backordered_amountinteger
surchargesArray of objects
Array
idinteger>= 0
typestring[1 .. 8] characters
codestring[1 .. 128] characters
classstring[1 .. 255] characters
includeboolean
availablebooleanDefault: true
valuenumber
namestring[1 .. 255] characters
weightinteger
billing_addressobject or null
  • object
idinteger>= 0
is_billingboolean
is_shippingboolean
is_workboolean
typestring
titlestring
firstnamestring
lastnamestring
phonestring
address1string
address2string
address3string
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger or null
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
shipping_addressobject or null
  • object
idinteger>= 0
is_billingboolean
is_shippingboolean
is_workboolean
typestring
titlestring
firstnamestring
lastnamestring
phonestring
address1string
address2string
address3string
zipcodestring<= 32 characters
citystring
country_codestring2 characters
stateinteger or null
state_namestring
custom_fieldsArray of objects
Array
namestring
valuestring
create_datestring
update_datestring
payment_statusobject or null
  • object
idinteger>= 0
codestring[1 .. 4] characters
namestring[1 .. 255] characters
customer_namestring[1 .. 255] characters
shipping_statusobject or null
  • object
idinteger>= 0
codestring[1 .. 4] characters
namestring[1 .. 255] characters
customer_namestring[1 .. 255] characters
customer_idinteger or null>= 0
order_profile_idinteger or null>= 0
shipping_idinteger or null>= 0
shipping_method_namestring or null
notesstring
admin_notesstring
currencystring
stock_statusstring
surchargesArray of objects
Array
idinteger>= 0
typestring[1 .. 8] characters
codestring[1 .. 128] characters
classstring[1 .. 255] characters
includeboolean
availablebooleanDefault: true
valuenumber
namestring[1 .. 255] characters
weightinteger
tracking_numbersArray of objects
Array
idinteger>= 0
datestring
valuestring
401Unauthorized
Response schema:
Unauthorized
typestring
titlestring
detailstring or null
instancestring or null
404Resource not found
Response schema:
Resource not found
typestring
titlestring
detailstring or null
instancestring or null
500Internal error
Response schema:
Internal error
typestring
titlestring
detailstring or null
instancestring or null