REST API Specification

View and test all available resources and methods

The following interactive tool enables developers to view and test all of the available resources and methods accessible via our REST API.

Resources include assets such as orders and products. Methods include standard HTTP requests such as GET, POST, PUT and DELETE. The API accepts query string parameters for GET and DELETE requests, and JSON data for POST and PUT requests, always responding with standard JSON data.

The API credentials below provide read only access to the Demopark.co.uk site, our demonstration site. Feel free to enter your own Bluepark site's API credentials, but please note that this testing tool will never make changes to any sites, regardless of the permissions associated with the credentials.

https://www.demopark.co.uk/api/v1

company

• GET

  Retrieve company information

  /company

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

orders

• GET

  Retrieve orders

  /orders

  Filter	Value	Type	Description
  ids	↓	string	Comma or pipe delimited list of resource IDs to retrieve
  order_number	↓	string	Order number to filter resources retrieved
  order_numbers	↓	string	Comma or pipe delimited list of order numbers to filter resources retrieved
  channel_id	↓	integer	Channel ID to filter resources retrieved
  channel_order_id	↓	integer	Channel order ID to filter resources retrieved
  channel_order_number	↓	string	Channel order number to filter resources retrieved
  order_date_min	↓	iso-8601	Minimum order date / time to filter resources retrieved
  order_date_max	↓	iso-8601	Maximum order date / time to filter resources retrieved
  status_id	↓	integer	Order status ID to filter resources retrieved 1 = Pending, 2 = Completed, 3 = Cancelled
  custom_status_id	↓	integer	Order custom status ID to filter resources retrieved
  custom_status_ids	↓	integer	Comma or pipe delimited list of order custom status IDs to filter resources retrieved
  paid	truefalse↓	boolean	Paid flag to filter resources retrieved
  user_id	↓	integer	User ID to filter resources retrieved
  email_address	↓	string	Email address to filter resources retrieved * wildcards allowed
  allow_contact	truefalse↓	boolean	Allow contact flag to filter resources retrieved
  filter_address	↓	integer	Optional address type to match when filtering resources retrieved 1 = Billing, 2 = Delivery
  first_name	↓	string	First name to filter resources retrieved * wildcards allowed
  last_name	↓	string	Last name to filter resources retrieved * wildcards allowed
  company_name	↓	string	Company name to filter resources retrieved * wildcards allowed
  address_line_1	↓	string	Address line 1 to filter resources retrieved * wildcards allowed
  town_city	↓	string	Town / city to filter resources retrieved * wildcards allowed
  postcode	↓	string	Postcode to filter resources retrieved * wildcards allowed
  country_code	↓	iso-3166-1-a2	Country code to filter resources retrieved
  telephone_number	↓	string	Telephone number to filter resources retrieved * wildcards allowed
  reference	↓	string	Reference to filter resources retrieved * wildcards allowed
  payment_method	↓	string	Payment method to filter resources retrieved applepay, bank_transfer, card, cheque, credit_account, googlepay, klarna, offline, paypal
  voucher_code	↓	string	Voucher code to filter resources retrieved
  coupon_code	↓	string	Coupon code to filter resources retrieved
  shipping_method_id	↓	integer	Shipping method ID to filter resources retrieved
  ip_address	↓	string	IP address to filter resources retrieved * wildcards allowed
  affiliate_id	↓	integer	Affiliate ID to filter resources retrieved
  sku	↓	string	Product or variant SKU to filter resources retrieved
  skus	↓	string	Comma or pipe delimited list of product or variant SKUs to filter resources retrieved
  bar_code	↓	string	Product or variant bar code to filter resources retrieved
  part_number	↓	string	Product or variant part number to filter resources retrieved
  title	↓	string	Resource title to filter resources retrieved * wildcards allowed
  brand_id	↓	integer	Brand ID to filter resources retrieved
  supplier_id	↓	integer	Supplier ID to filter resources retrieved
  modified_since	↓	iso-8601	Modified since date / time to filter resources retrieved

  Formatter	Value	Type	Description
  fields	↓	string	Comma or pipe delimited list of fields to retrieve
  	CLEAR----------idorder_numberchannelinvoice_numberorder_dateinvoice_datedue_datedelivery_datedespatch_datestatuscustom_statuspaidpaid_onplaced_bycompleted_oncompleted_byuser_idemail_addressallow_contactbilling_addressdelivery_addresscurrency_codevat_ratevat_basepayment_methodpayment_checkspayment_idpayment_typepayment_takenpayment_refundedvoucher_codevoucher_totalpoints_usedpoints_totalproductsdiscount_total_exc_vatdiscount_total_inc_vatcoupon_codecoupon_total_exc_vatcoupon_total_inc_vatweight_totalshipping_methodshipping_vat_rateshipping_total_exc_vatshipping_total_inc_vatshipping_total_vatddp_dutiesddp_feesddp_taxestotal_exc_vattotal_inc_vattotal_vatrefunded_totalpoints_earnedip_addressdevice_typesite_versionaffiliatereferring_domainreferring_searchcustomer_commentsadmin_commentsadmin_comments_publicsafe_placedo_processdo_send_emaildo_take_paymentdo_take_amountdo_refund_paymentdo_refund_amountdo_tracking_numberdo_append_to_emaildo_send_confirmation
  sort	↓	string	Field to sort resources retrieved by id, order_number, order_date
  order	↓	string	Order to apply to sorted resources asc, desc

  Paginator	Value	Type	Description
  limit	↓	integer	Number of resources to retrieve
  page	↓	integer	Page number of limited resources to retrieve

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• GET

  Retrieve single order

  /orders/:id

  Identifier	Value	Type
  id	↓	integer

  Formatter	Value	Type	Description
  fields	↓	string	Comma or pipe delimited list of fields to retrieve
  	CLEAR----------idorder_numberchannelinvoice_numberorder_dateinvoice_datedue_datedelivery_datedespatch_datestatuscustom_statuspaidpaid_onplaced_bycompleted_oncompleted_byuser_idemail_addressallow_contactbilling_addressdelivery_addresscurrency_codevat_ratevat_basepayment_methodpayment_checkspayment_idpayment_typepayment_takenpayment_refundedvoucher_codevoucher_totalpoints_usedpoints_totalproductsdiscount_total_exc_vatdiscount_total_inc_vatcoupon_codecoupon_total_exc_vatcoupon_total_inc_vatweight_totalshipping_methodshipping_vat_rateshipping_total_exc_vatshipping_total_inc_vatshipping_total_vatddp_dutiesddp_feesddp_taxestotal_exc_vattotal_inc_vattotal_vatrefunded_totalpoints_earnedip_addressdevice_typesite_versionaffiliatereferring_domainreferring_searchcustomer_commentsadmin_commentsadmin_comments_publicsafe_placedo_processdo_send_emaildo_take_paymentdo_take_amountdo_refund_paymentdo_refund_amountdo_tracking_numberdo_append_to_emaildo_send_confirmation

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• GET

  Count orders

  /orders/count

  Filter	Value	Type	Description
  ids	↓	string	Comma or pipe delimited list of resource IDs to retrieve
  order_number	↓	string	Order number to filter resources retrieved
  order_numbers	↓	string	Comma or pipe delimited list of order numbers to filter resources retrieved
  channel_id	↓	integer	Channel ID to filter resources retrieved
  channel_order_id	↓	integer	Channel order ID to filter resources retrieved
  channel_order_number	↓	string	Channel order number to filter resources retrieved
  order_date_min	↓	iso-8601	Minimum order date / time to filter resources retrieved
  order_date_max	↓	iso-8601	Maximum order date / time to filter resources retrieved
  status_id	↓	integer	Order status ID to filter resources retrieved 1 = Pending, 2 = Completed, 3 = Cancelled
  custom_status_id	↓	integer	Order custom status ID to filter resources retrieved
  custom_status_ids	↓	integer	Comma or pipe delimited list of order custom status IDs to filter resources retrieved
  paid	truefalse↓	boolean	Paid flag to filter resources retrieved
  user_id	↓	integer	User ID to filter resources retrieved
  email_address	↓	string	Email address to filter resources retrieved * wildcards allowed
  allow_contact	truefalse↓	boolean	Allow contact flag to filter resources retrieved
  filter_address	↓	integer	Optional address type to match when filtering resources retrieved 1 = Billing, 2 = Delivery
  first_name	↓	string	First name to filter resources retrieved * wildcards allowed
  last_name	↓	string	Last name to filter resources retrieved * wildcards allowed
  company_name	↓	string	Company name to filter resources retrieved * wildcards allowed
  address_line_1	↓	string	Address line 1 to filter resources retrieved * wildcards allowed
  town_city	↓	string	Town / city to filter resources retrieved * wildcards allowed
  postcode	↓	string	Postcode to filter resources retrieved * wildcards allowed
  country_code	↓	iso-3166-1-a2	Country code to filter resources retrieved
  telephone_number	↓	string	Telephone number to filter resources retrieved * wildcards allowed
  reference	↓	string	Reference to filter resources retrieved * wildcards allowed
  payment_method	↓	string	Payment method to filter resources retrieved applepay, bank_transfer, card, cheque, credit_account, googlepay, klarna, offline, paypal
  voucher_code	↓	string	Voucher code to filter resources retrieved
  coupon_code	↓	string	Coupon code to filter resources retrieved
  shipping_method_id	↓	integer	Shipping method ID to filter resources retrieved
  ip_address	↓	string	IP address to filter resources retrieved * wildcards allowed
  affiliate_id	↓	integer	Affiliate ID to filter resources retrieved
  sku	↓	string	Product or variant SKU to filter resources retrieved
  skus	↓	string	Comma or pipe delimited list of product or variant SKUs to filter resources retrieved
  bar_code	↓	string	Product or variant bar code to filter resources retrieved
  part_number	↓	string	Product or variant part number to filter resources retrieved
  title	↓	string	Resource title to filter resources retrieved * wildcards allowed
  brand_id	↓	integer	Brand ID to filter resources retrieved
  supplier_id	↓	integer	Supplier ID to filter resources retrieved
  modified_since	↓	iso-8601	Modified since date / time to filter resources retrieved

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• POST

  Create one or more orders

  /orders

  Parameter	Value	Type	Description
  Delete#1orders channel ►  Expand Singleton object Channel orders  >  channel id ↓ OR integer ID name ↓ OR string Name order_id ↓ integer Order ID order_number ↓ string Order number orders  >  channel invoice_number ↓ string Invoice number order_date ↓ iso-8601 Order date invoice_date ↓ iso-8601 Invoice date due_date ↓ iso-8601 Due date delivery_date ↓ iso-8601 Delivery date despatch_date ↓ iso-8601 Despatch date status ►  Expand Singleton object Status orders  >  status id ↓ OR integer ID 1 = Pending, 2 = Completed, 3 = Cancelled name ↓ OR string Name orders  >  status custom_status ►  Expand Singleton object Custom status orders  >  custom_status id ↓ OR integer ID name ↓ OR string Name orders  >  custom_status paid truefalse↓ boolean Paid paid_on ↓ iso-8601 Paid on placed_by ↓ string Placed by completed_on ↓ iso-8601 Completed on completed_by ↓ string Completed by user_id ↓ integer User ID email_address ↓ string Email address allow_contact truefalse↓ boolean Allow contact billing_address ►  Expand Singleton object Billing address orders  >  billing_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number vat_number ↓ string VAT number eori_number ↓ string EORI number facebook_id ↓ string Facebook ID reference ↓ string Reference orders  >  billing_address delivery_address ►  Expand Singleton object Delivery address orders  >  delivery_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number orders  >  delivery_address currency_code ↓ iso-4217-a3 Currency code vat_rate ↓ float VAT rate vat_base ↓ string VAT base inc, exc payment_method ►  Expand Singleton object Payment method orders  >  payment_method value ↓ string Value applepay, bank_transfer, card, cheque, credit_account, googlepay, klarna, offline, paypal card_type ↓ string Card type card_digits ↓ string Card digits orders  >  payment_method payment_checks ►  Expand Singleton object Payment checks orders  >  payment_checks failures ↓ integer Failures avs_address ↓ string AVS address avs_postcode ↓ string AVS postcode cv2 ↓ string CV2 3ds ↓ string 3DS orders  >  payment_checks payment_id ↓ string Payment ID payment_type ↓ string Payment type instant, defer, auth, cancel payment_taken ↓ float Payment taken payment_refunded ↓ float Payment refunded voucher_code ↓ string Voucher code voucher_total ↓ float Voucher total points_used ↓ integer Points used points_total ↓ float Points total products ►  Expand Collection array Products Delete#1orders  >  products sku ↓ OR string SKU variant_id ↓ OR string Variant ID product_sku ↓ OR string Product SKU product_id ↓ OR integer Product ID bar_code ↓ string Bar code part_number ↓ string Part number title ↓ string Title variant_title ↓ string Variant title category ►  Expand Singleton object Category orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category brand ►  Expand Singleton object Brand orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand supplier ►  Expand Singleton object Supplier orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier intangible truefalse↓ boolean Intangible product_file ►  Expand Singleton object Product file orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file file_group ►  Expand Singleton object File group orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group bundle truefalse↓ boolean Bundle bundled ►  Expand Singleton object Bundled orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled gift_voucher truefalse↓ boolean Gift voucher weight ↓ float Weight commodity_code ↓ string Commodity code country_of_origin ↓ iso-3166-1-a2 Country of origin quantity ↓ integer Quantity quantity_picked ↓ integer Quantity picked quantity_shipped ↓ integer Quantity shipped quantity_refunded ↓ integer Quantity refunded warehouse_location ↓ string Warehouse location frequency ↓ string Frequency instalments ↓ integer Instalments vat_rate ↓ float VAT rate price_cost_exc_vat ↓ float Price cost exc VAT price_cost_inc_vat ↓ float Price cost inc VAT price_cost_vat ↓ float Price cost VAT price_full_exc_vat ↓ float Price full exc VAT price_full_inc_vat ↓ float Price full inc VAT price_full_vat ↓ float Price full VAT price_paid_exc_vat ↓ float Price paid exc VAT price_paid_inc_vat ↓ float Price paid inc VAT price_paid_vat ↓ float Price paid VAT addition_lines ►  Expand Collection array Addition lines Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines url ↓ string URL image_url ↓ string Image URL Add Another +orders  >  products discount_total_exc_vat ↓ float Discount total exc VAT discount_total_inc_vat ↓ float Discount total inc VAT coupon_code ↓ string Coupon code coupon_total_exc_vat ↓ float Coupon total exc VAT coupon_total_inc_vat ↓ float Coupon total inc VAT weight_total ↓ float Weight total shipping_method ►  Expand Singleton object Shipping method orders  >  shipping_method id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference orders  >  shipping_method shipping_vat_rate ↓ float Shipping VAT rate shipping_total_exc_vat ↓ float Shipping total exc VAT shipping_total_inc_vat ↓ float Shipping total inc VAT shipping_total_vat ↓ float Shipping total VAT ddp_duties ↓ float Ddp duties ddp_fees ↓ float Ddp fees ddp_taxes ↓ float Ddp taxes total_exc_vat ↓ float Total exc VAT total_inc_vat ↓ float Total inc VAT total_vat ↓ float Total VAT refunded_total ↓ float Refunded total points_earned ↓ integer Points earned ip_address ↓ string IP address device_type ↓ string Device type desktop, tablet, mobile site_version ↓ string Site version desktop, mobile affiliate ►  Expand Singleton object Affiliate orders  >  affiliate id ↓ OR integer ID name ↓ OR string Name orders  >  affiliate referring_domain ↓ string Referring domain referring_search ↓ string Referring search customer_comments ↓ string Customer comments admin_comments ↓ string Admin comments admin_comments_public truefalse↓ boolean Admin comments public safe_place ↓ string Safe place do_process truefalse↓ boolean Do: Process Perform order processing actions, required for all available actions, effective only for existing orders do_send_email truefalse↓ boolean Do: Send email Send an email to the customer do_take_payment truefalse↓ boolean Do: Take payment Take any outstanding payment, limited to supported payment processors do_take_amount ↓ float Do: Take amount Take a specific payment amount do_refund_payment truefalse↓ boolean Do: Refund payment Refund the payment, limited to supported payment processors do_refund_amount ↓ float Do: Refund amount Refund a specific amount, required for all refund requests do_tracking_number ↓ string Do: Tracking number Add a tracking number to any despatch notes created during order processing do_append_to_email ↓ string Do: Append to email Append a line of text to the customer's email do_send_confirmation truefalse↓ boolean Do: Send confirmation Send the order confirmation email to the customer Add Another +orders

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• PUT

  Update one or more orders

  /orders

  Parameter	Value	Type	Description
  Delete#1orders id ↓ OR integer ID order_number ↓ OR string Order number channel ►  Expand Singleton object Channel orders  >  channel id ↓ OR integer ID name ↓ OR string Name order_id ↓ integer Order ID order_number ↓ string Order number orders  >  channel invoice_number ↓ string Invoice number order_date ↓ iso-8601 Order date invoice_date ↓ iso-8601 Invoice date due_date ↓ iso-8601 Due date delivery_date ↓ iso-8601 Delivery date despatch_date ↓ iso-8601 Despatch date status ►  Expand Singleton object Status orders  >  status id ↓ OR integer ID 1 = Pending, 2 = Completed, 3 = Cancelled name ↓ OR string Name orders  >  status custom_status ►  Expand Singleton object Custom status orders  >  custom_status id ↓ OR integer ID name ↓ OR string Name orders  >  custom_status paid truefalse↓ boolean Paid paid_on ↓ iso-8601 Paid on placed_by ↓ string Placed by completed_on ↓ iso-8601 Completed on completed_by ↓ string Completed by user_id ↓ integer User ID email_address ↓ string Email address allow_contact truefalse↓ boolean Allow contact billing_address ►  Expand Singleton object Billing address orders  >  billing_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number vat_number ↓ string VAT number eori_number ↓ string EORI number facebook_id ↓ string Facebook ID reference ↓ string Reference orders  >  billing_address delivery_address ►  Expand Singleton object Delivery address orders  >  delivery_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number orders  >  delivery_address currency_code ↓ iso-4217-a3 Currency code vat_rate ↓ float VAT rate vat_base ↓ string VAT base inc, exc payment_method ►  Expand Singleton object Payment method orders  >  payment_method value ↓ string Value applepay, bank_transfer, card, cheque, credit_account, googlepay, klarna, offline, paypal card_type ↓ string Card type card_digits ↓ string Card digits orders  >  payment_method payment_checks ►  Expand Singleton object Payment checks orders  >  payment_checks failures ↓ integer Failures avs_address ↓ string AVS address avs_postcode ↓ string AVS postcode cv2 ↓ string CV2 3ds ↓ string 3DS orders  >  payment_checks payment_id ↓ string Payment ID payment_type ↓ string Payment type instant, defer, auth, cancel payment_taken ↓ float Payment taken payment_refunded ↓ float Payment refunded voucher_code ↓ string Voucher code voucher_total ↓ float Voucher total points_used ↓ integer Points used points_total ↓ float Points total products ►  Expand Collection array Products Delete#1orders  >  products sku ↓ OR string SKU variant_id ↓ OR string Variant ID product_sku ↓ OR string Product SKU product_id ↓ OR integer Product ID bar_code ↓ string Bar code part_number ↓ string Part number title ↓ string Title variant_title ↓ string Variant title category ►  Expand Singleton object Category orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category brand ►  Expand Singleton object Brand orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand supplier ►  Expand Singleton object Supplier orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier intangible truefalse↓ boolean Intangible product_file ►  Expand Singleton object Product file orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file file_group ►  Expand Singleton object File group orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group bundle truefalse↓ boolean Bundle bundled ►  Expand Singleton object Bundled orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled gift_voucher truefalse↓ boolean Gift voucher weight ↓ float Weight commodity_code ↓ string Commodity code country_of_origin ↓ iso-3166-1-a2 Country of origin quantity ↓ integer Quantity quantity_picked ↓ integer Quantity picked quantity_shipped ↓ integer Quantity shipped quantity_refunded ↓ integer Quantity refunded warehouse_location ↓ string Warehouse location frequency ↓ string Frequency instalments ↓ integer Instalments vat_rate ↓ float VAT rate price_cost_exc_vat ↓ float Price cost exc VAT price_cost_inc_vat ↓ float Price cost inc VAT price_cost_vat ↓ float Price cost VAT price_full_exc_vat ↓ float Price full exc VAT price_full_inc_vat ↓ float Price full inc VAT price_full_vat ↓ float Price full VAT price_paid_exc_vat ↓ float Price paid exc VAT price_paid_inc_vat ↓ float Price paid inc VAT price_paid_vat ↓ float Price paid VAT addition_lines ►  Expand Collection array Addition lines Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines url ↓ string URL image_url ↓ string Image URL Add Another +orders  >  products discount_total_exc_vat ↓ float Discount total exc VAT discount_total_inc_vat ↓ float Discount total inc VAT coupon_code ↓ string Coupon code coupon_total_exc_vat ↓ float Coupon total exc VAT coupon_total_inc_vat ↓ float Coupon total inc VAT weight_total ↓ float Weight total shipping_method ►  Expand Singleton object Shipping method orders  >  shipping_method id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference orders  >  shipping_method shipping_vat_rate ↓ float Shipping VAT rate shipping_total_exc_vat ↓ float Shipping total exc VAT shipping_total_inc_vat ↓ float Shipping total inc VAT shipping_total_vat ↓ float Shipping total VAT ddp_duties ↓ float Ddp duties ddp_fees ↓ float Ddp fees ddp_taxes ↓ float Ddp taxes total_exc_vat ↓ float Total exc VAT total_inc_vat ↓ float Total inc VAT total_vat ↓ float Total VAT refunded_total ↓ float Refunded total points_earned ↓ integer Points earned ip_address ↓ string IP address device_type ↓ string Device type desktop, tablet, mobile site_version ↓ string Site version desktop, mobile affiliate ►  Expand Singleton object Affiliate orders  >  affiliate id ↓ OR integer ID name ↓ OR string Name orders  >  affiliate referring_domain ↓ string Referring domain referring_search ↓ string Referring search customer_comments ↓ string Customer comments admin_comments ↓ string Admin comments admin_comments_public truefalse↓ boolean Admin comments public safe_place ↓ string Safe place do_process truefalse↓ boolean Do: Process Perform order processing actions, required for all available actions, effective only for existing orders do_send_email truefalse↓ boolean Do: Send email Send an email to the customer do_take_payment truefalse↓ boolean Do: Take payment Take any outstanding payment, limited to supported payment processors do_take_amount ↓ float Do: Take amount Take a specific payment amount do_refund_payment truefalse↓ boolean Do: Refund payment Refund the payment, limited to supported payment processors do_refund_amount ↓ float Do: Refund amount Refund a specific amount, required for all refund requests do_tracking_number ↓ string Do: Tracking number Add a tracking number to any despatch notes created during order processing do_append_to_email ↓ string Do: Append to email Append a line of text to the customer's email do_send_confirmation truefalse↓ boolean Do: Send confirmation Send the order confirmation email to the customer Add Another +orders

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• PUT

  Update single order

  /orders/:id

  Identifier	Value	Type
  id	↓	integer

  Parameter	Value	Type	Description
  channel	►  Expand Singleton	object	Channel
  orders  >  channel id ↓ OR integer ID name ↓ OR string Name order_id ↓ integer Order ID order_number ↓ string Order number orders  >  channel
  invoice_number	↓	string	Invoice number
  order_date	↓	iso-8601	Order date
  invoice_date	↓	iso-8601	Invoice date
  due_date	↓	iso-8601	Due date
  delivery_date	↓	iso-8601	Delivery date
  despatch_date	↓	iso-8601	Despatch date
  status	►  Expand Singleton	object	Status
  orders  >  status id ↓ OR integer ID 1 = Pending, 2 = Completed, 3 = Cancelled name ↓ OR string Name orders  >  status
  custom_status	►  Expand Singleton	object	Custom status
  orders  >  custom_status id ↓ OR integer ID name ↓ OR string Name orders  >  custom_status
  paid	truefalse↓	boolean	Paid
  paid_on	↓	iso-8601	Paid on
  placed_by	↓	string	Placed by
  completed_on	↓	iso-8601	Completed on
  completed_by	↓	string	Completed by
  user_id	↓	integer	User ID
  email_address	↓	string	Email address
  allow_contact	truefalse↓	boolean	Allow contact
  billing_address	►  Expand Singleton	object	Billing address
  orders  >  billing_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number vat_number ↓ string VAT number eori_number ↓ string EORI number facebook_id ↓ string Facebook ID reference ↓ string Reference orders  >  billing_address
  delivery_address	►  Expand Singleton	object	Delivery address
  orders  >  delivery_address title ↓ string Title title_id ↓ integer Title ID 1 = Mr, 2 = Mrs, 3 = Miss, 4 = Ms, 5 = Dr first_name ↓ string First name last_name ↓ string Last name company_name ↓ string Company name address_line_1 ↓ string Address line 1 address_line_2 ↓ string Address line 2 town_city ↓ string Town / city county ↓ string County postcode ↓ string Postcode country ↓ string Country country_code ↓ iso-3166-1-a2 Country code telephone_number ↓ string Telephone number orders  >  delivery_address
  currency_code	↓	iso-4217-a3	Currency code
  vat_rate	↓	float	VAT rate
  vat_base	↓	string	VAT base inc, exc
  payment_method	►  Expand Singleton	object	Payment method
  orders  >  payment_method value ↓ string Value applepay, bank_transfer, card, cheque, credit_account, googlepay, klarna, offline, paypal card_type ↓ string Card type card_digits ↓ string Card digits orders  >  payment_method
  payment_checks	►  Expand Singleton	object	Payment checks
  orders  >  payment_checks failures ↓ integer Failures avs_address ↓ string AVS address avs_postcode ↓ string AVS postcode cv2 ↓ string CV2 3ds ↓ string 3DS orders  >  payment_checks
  payment_id	↓	string	Payment ID
  payment_type	↓	string	Payment type instant, defer, auth, cancel
  payment_taken	↓	float	Payment taken
  payment_refunded	↓	float	Payment refunded
  voucher_code	↓	string	Voucher code
  voucher_total	↓	float	Voucher total
  points_used	↓	integer	Points used
  points_total	↓	float	Points total
  products	►  Expand Collection	array	Products
  Delete#1orders  >  products sku ↓ OR string SKU variant_id ↓ OR string Variant ID product_sku ↓ OR string Product SKU product_id ↓ OR integer Product ID bar_code ↓ string Bar code part_number ↓ string Part number title ↓ string Title variant_title ↓ string Variant title category ►  Expand Singleton object Category orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category brand ►  Expand Singleton object Brand orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand supplier ►  Expand Singleton object Supplier orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier intangible truefalse↓ boolean Intangible product_file ►  Expand Singleton object Product file orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file file_group ►  Expand Singleton object File group orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group bundle truefalse↓ boolean Bundle bundled ►  Expand Singleton object Bundled orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled gift_voucher truefalse↓ boolean Gift voucher weight ↓ float Weight commodity_code ↓ string Commodity code country_of_origin ↓ iso-3166-1-a2 Country of origin quantity ↓ integer Quantity quantity_picked ↓ integer Quantity picked quantity_shipped ↓ integer Quantity shipped quantity_refunded ↓ integer Quantity refunded warehouse_location ↓ string Warehouse location frequency ↓ string Frequency instalments ↓ integer Instalments vat_rate ↓ float VAT rate price_cost_exc_vat ↓ float Price cost exc VAT price_cost_inc_vat ↓ float Price cost inc VAT price_cost_vat ↓ float Price cost VAT price_full_exc_vat ↓ float Price full exc VAT price_full_inc_vat ↓ float Price full inc VAT price_full_vat ↓ float Price full VAT price_paid_exc_vat ↓ float Price paid exc VAT price_paid_inc_vat ↓ float Price paid inc VAT price_paid_vat ↓ float Price paid VAT addition_lines ►  Expand Collection array Addition lines Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines url ↓ string URL image_url ↓ string Image URL Add Another +orders  >  products
  discount_total_exc_vat	↓	float	Discount total exc VAT
  discount_total_inc_vat	↓	float	Discount total inc VAT
  coupon_code	↓	string	Coupon code
  coupon_total_exc_vat	↓	float	Coupon total exc VAT
  coupon_total_inc_vat	↓	float	Coupon total inc VAT
  weight_total	↓	float	Weight total
  shipping_method	►  Expand Singleton	object	Shipping method
  orders  >  shipping_method id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference orders  >  shipping_method
  shipping_vat_rate	↓	float	Shipping VAT rate
  shipping_total_exc_vat	↓	float	Shipping total exc VAT
  shipping_total_inc_vat	↓	float	Shipping total inc VAT
  shipping_total_vat	↓	float	Shipping total VAT
  ddp_duties	↓	float	Ddp duties
  ddp_fees	↓	float	Ddp fees
  ddp_taxes	↓	float	Ddp taxes
  total_exc_vat	↓	float	Total exc VAT
  total_inc_vat	↓	float	Total inc VAT
  total_vat	↓	float	Total VAT
  refunded_total	↓	float	Refunded total
  points_earned	↓	integer	Points earned
  ip_address	↓	string	IP address
  device_type	↓	string	Device type desktop, tablet, mobile
  site_version	↓	string	Site version desktop, mobile
  affiliate	►  Expand Singleton	object	Affiliate
  orders  >  affiliate id ↓ OR integer ID name ↓ OR string Name orders  >  affiliate
  referring_domain	↓	string	Referring domain
  referring_search	↓	string	Referring search
  customer_comments	↓	string	Customer comments
  admin_comments	↓	string	Admin comments
  admin_comments_public	truefalse↓	boolean	Admin comments public
  safe_place	↓	string	Safe place
  do_process	truefalse↓	boolean	Do: Process Perform order processing actions, required for all available actions, effective only for existing orders
  do_send_email	truefalse↓	boolean	Do: Send email Send an email to the customer
  do_take_payment	truefalse↓	boolean	Do: Take payment Take any outstanding payment, limited to supported payment processors
  do_take_amount	↓	float	Do: Take amount Take a specific payment amount
  do_refund_payment	truefalse↓	boolean	Do: Refund payment Refund the payment, limited to supported payment processors
  do_refund_amount	↓	float	Do: Refund amount Refund a specific amount, required for all refund requests
  do_tracking_number	↓	string	Do: Tracking number Add a tracking number to any despatch notes created during order processing
  do_append_to_email	↓	string	Do: Append to email Append a line of text to the customer's email
  do_send_confirmation	truefalse↓	boolean	Do: Send confirmation Send the order confirmation email to the customer

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• DELETE

  Delete all orders

  /orders/all

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• DELETE

  Delete single order

  /orders/:id

  Identifier	Value	Type
  id	↓	integer

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

orders/:id/products

• GET

  Retrieve products

  /orders/:id/products

  Identifier	Value	Type
  orders:  id	↓

  Filter	Value	Type	Description
  ids	↓	string	Comma or pipe delimited list of resource IDs to retrieve
  sku	↓	string	Product or variant SKU to filter resources retrieved
  skus	↓	string	Comma or pipe delimited list of product or variant SKUs to filter resources retrieved
  bar_code	↓	string	Product or variant bar code to filter resources retrieved
  part_number	↓	string	Product or variant part number to filter resources retrieved
  title	↓	string	Resource title to filter resources retrieved * wildcards allowed
  brand_id	↓	integer	Brand ID to filter resources retrieved
  supplier_id	↓	integer	Supplier ID to filter resources retrieved
  modified_since	↓	iso-8601	Modified since date / time to filter resources retrieved

  Formatter	Value	Type	Description
  fields	↓	string	Comma or pipe delimited list of fields to retrieve
  	CLEAR----------idskuvariant_idproduct_skubar_codepart_numbertitlevariant_titlecategorybrandsupplierintangibleproduct_filefile_groupbundlebundledgift_voucherweightcommodity_codecountry_of_originquantityquantity_pickedquantity_shippedquantity_refundedwarehouse_locationfrequencyinstalmentsvat_rateprice_cost_exc_vatprice_cost_inc_vatprice_cost_vatprice_full_exc_vatprice_full_inc_vatprice_full_vatprice_paid_exc_vatprice_paid_inc_vatprice_paid_vataddition_linesimage_url
  sort	↓	string	Field to sort resources retrieved by id, sku, title
  order	↓	string	Order to apply to sorted resources asc, desc

  Paginator	Value	Type	Description
  limit	↓	integer	Number of resources to retrieve
  page	↓	integer	Page number of limited resources to retrieve

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• GET

  Retrieve single product

  /orders/:id/products/:id

  Identifier	Value	Type
  orders:  id	↓	integer
  products:  id	↓	integer

  Formatter	Value	Type	Description
  fields	↓	string	Comma or pipe delimited list of fields to retrieve
  	CLEAR----------idskuvariant_idproduct_skubar_codepart_numbertitlevariant_titlecategorybrandsupplierintangibleproduct_filefile_groupbundlebundledgift_voucherweightcommodity_codecountry_of_originquantityquantity_pickedquantity_shippedquantity_refundedwarehouse_locationfrequencyinstalmentsvat_rateprice_cost_exc_vatprice_cost_inc_vatprice_cost_vatprice_full_exc_vatprice_full_inc_vatprice_full_vatprice_paid_exc_vatprice_paid_inc_vatprice_paid_vataddition_linesimage_url

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• GET

  Count products

  /orders/:id/products/count

  Identifier	Value	Type
  orders:  id	↓	string

  Filter	Value	Type	Description
  ids	↓	string	Comma or pipe delimited list of resource IDs to retrieve
  sku	↓	string	Product or variant SKU to filter resources retrieved
  skus	↓	string	Comma or pipe delimited list of product or variant SKUs to filter resources retrieved
  bar_code	↓	string	Product or variant bar code to filter resources retrieved
  part_number	↓	string	Product or variant part number to filter resources retrieved
  title	↓	string	Resource title to filter resources retrieved * wildcards allowed
  brand_id	↓	integer	Brand ID to filter resources retrieved
  supplier_id	↓	integer	Supplier ID to filter resources retrieved
  modified_since	↓	iso-8601	Modified since date / time to filter resources retrieved

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• POST

  Create one or more products

  /orders/:id/products

  Identifier	Value	Type
  orders:  id	↓

  Parameter	Value	Type	Description
  Delete#1orders  >  products sku ↓ OR string SKU variant_id ↓ OR string Variant ID product_sku ↓ OR string Product SKU product_id ↓ OR integer Product ID bar_code ↓ string Bar code part_number ↓ string Part number title ↓ string Title variant_title ↓ string Variant title category ►  Expand Singleton object Category orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category brand ►  Expand Singleton object Brand orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand supplier ►  Expand Singleton object Supplier orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier intangible truefalse↓ boolean Intangible product_file ►  Expand Singleton object Product file orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file file_group ►  Expand Singleton object File group orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group bundle truefalse↓ boolean Bundle bundled ►  Expand Singleton object Bundled orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled gift_voucher truefalse↓ boolean Gift voucher weight ↓ float Weight commodity_code ↓ string Commodity code country_of_origin ↓ iso-3166-1-a2 Country of origin quantity ↓ integer Quantity quantity_picked ↓ integer Quantity picked quantity_shipped ↓ integer Quantity shipped quantity_refunded ↓ integer Quantity refunded warehouse_location ↓ string Warehouse location frequency ↓ string Frequency instalments ↓ integer Instalments vat_rate ↓ float VAT rate price_cost_exc_vat ↓ float Price cost exc VAT price_cost_inc_vat ↓ float Price cost inc VAT price_cost_vat ↓ float Price cost VAT price_full_exc_vat ↓ float Price full exc VAT price_full_inc_vat ↓ float Price full inc VAT price_full_vat ↓ float Price full VAT price_paid_exc_vat ↓ float Price paid exc VAT price_paid_inc_vat ↓ float Price paid inc VAT price_paid_vat ↓ float Price paid VAT addition_lines ►  Expand Collection array Addition lines Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines image_url ↓ string Image URL Add Another +orders  >  products

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• PUT

  Update one or more products

  /orders/:id/products

  Identifier	Value	Type
  orders:  id	↓

  Parameter	Value	Type	Description
  Delete#1orders  >  products id ↓ OR integer ID sku ↓ OR string SKU variant_id ↓ string Variant ID product_sku ↓ string Product SKU bar_code ↓ string Bar code part_number ↓ string Part number title ↓ string Title variant_title ↓ string Variant title category ►  Expand Singleton object Category orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category brand ►  Expand Singleton object Brand orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand supplier ►  Expand Singleton object Supplier orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier intangible truefalse↓ boolean Intangible product_file ►  Expand Singleton object Product file orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file file_group ►  Expand Singleton object File group orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group bundle truefalse↓ boolean Bundle bundled ►  Expand Singleton object Bundled orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled gift_voucher truefalse↓ boolean Gift voucher weight ↓ float Weight commodity_code ↓ string Commodity code country_of_origin ↓ iso-3166-1-a2 Country of origin quantity ↓ integer Quantity quantity_picked ↓ integer Quantity picked quantity_shipped ↓ integer Quantity shipped quantity_refunded ↓ integer Quantity refunded warehouse_location ↓ string Warehouse location frequency ↓ string Frequency instalments ↓ integer Instalments vat_rate ↓ float VAT rate price_cost_exc_vat ↓ float Price cost exc VAT price_cost_inc_vat ↓ float Price cost inc VAT price_cost_vat ↓ float Price cost VAT price_full_exc_vat ↓ float Price full exc VAT price_full_inc_vat ↓ float Price full inc VAT price_full_vat ↓ float Price full VAT price_paid_exc_vat ↓ float Price paid exc VAT price_paid_inc_vat ↓ float Price paid inc VAT price_paid_vat ↓ float Price paid VAT addition_lines ►  Expand Collection array Addition lines Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines image_url ↓ string Image URL Add Another +orders  >  products

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• PUT

  Update single product

  /orders/:id/products/:id

  Identifier	Value	Type
  orders:  id	↓	integer
  products:  id	↓	integer

  Parameter	Value	Type	Description
  sku	↓	string	SKU
  variant_id	↓	string	Variant ID
  product_sku	↓	string	Product SKU
  bar_code	↓	string	Bar code
  part_number	↓	string	Part number
  title	↓	string	Title
  variant_title	↓	string	Variant title
  category	►  Expand Singleton	object	Category
  orders  >  products  >  category id ↓ OR integer ID title_path ↓ OR string Title path orders  >  products  >  category
  brand	►  Expand Singleton	object	Brand
  orders  >  products  >  brand id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  brand
  supplier	►  Expand Singleton	object	Supplier
  orders  >  products  >  supplier id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  supplier
  intangible	truefalse↓	boolean	Intangible
  product_file	►  Expand Singleton	object	Product file
  orders  >  products  >  product_file value ↓ OR string Value url ↓ OR string URL downloaded ↓ integer Downloaded orders  >  products  >  product_file
  file_group	►  Expand Singleton	object	File group
  orders  >  products  >  file_group id ↓ OR integer ID name ↓ OR string Name orders  >  products  >  file_group
  bundle	truefalse↓	boolean	Bundle
  bundled	►  Expand Singleton	object	Bundled
  orders  >  products  >  bundled parent_id ↓ OR integer Parent ID parent_sku ↓ OR string Parent SKU orders  >  products  >  bundled
  gift_voucher	truefalse↓	boolean	Gift voucher
  weight	↓	float	Weight
  commodity_code	↓	string	Commodity code
  country_of_origin	↓	iso-3166-1-a2	Country of origin
  quantity	↓	integer	Quantity
  quantity_picked	↓	integer	Quantity picked
  quantity_shipped	↓	integer	Quantity shipped
  quantity_refunded	↓	integer	Quantity refunded
  warehouse_location	↓	string	Warehouse location
  frequency	↓	string	Frequency
  instalments	↓	integer	Instalments
  vat_rate	↓	float	VAT rate
  price_cost_exc_vat	↓	float	Price cost exc VAT
  price_cost_inc_vat	↓	float	Price cost inc VAT
  price_cost_vat	↓	float	Price cost VAT
  price_full_exc_vat	↓	float	Price full exc VAT
  price_full_inc_vat	↓	float	Price full inc VAT
  price_full_vat	↓	float	Price full VAT
  price_paid_exc_vat	↓	float	Price paid exc VAT
  price_paid_inc_vat	↓	float	Price paid inc VAT
  price_paid_vat	↓	float	Price paid VAT
  addition_lines	►  Expand Collection	array	Addition lines
  Delete#1orders  >  products  >  addition_lines additions ►  Expand Collection array Additions Delete#1orders  >  products  >  addition_lines  >  additions id ↓ OR integer ID name ↓ OR string Name reference ↓ string Reference charge ↓ float Charge weight ↓ float Weight field ►  Expand Singleton object Field orders  >  products  >  addition_lines  >  additions  >  field id ↓ integer ID name ↓ string Name value ↓ string Value url ↓ string URL orders  >  products  >  addition_lines  >  additions  >  field fields ►  Expand Collection array Fields Delete#1orders  >  products  >  addition_lines  >  additions  >  fields name ↓ string Name value ↓ string Value url ↓ string URL Add Another +orders  >  products  >  addition_lines  >  additions  >  fields Add Another +orders  >  products  >  addition_lines  >  additions Add Another +orders  >  products  >  addition_lines
  image_url	↓	string	Image URL

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• DELETE

  Delete all products

  /orders/:id/products/all

  Identifier	Value	Type
  orders:  id	↓	string

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body

• DELETE

  Delete single product

  /orders/:id/products/:id

  Identifier	Value	Type
  orders:  id	↓	integer
  products:  id	↓	integer

  TopResetShow RequestSubmit RequestClear Results

  Select AllRequest URL

  Select AllResponse Code

  Select AllResponse Headers

  Select AllResponse Content

  Select AllRequest Query String

  Select AllRequest Body