REST web service interface

GET orders/treated

Updated, 2012-06-19 14:28

Returns a list of commands that have been processed.

Resource Information

Rate Limited? No
Authentication Mandatory
Response Formats json,xml
HTTP Methods GET
Response Object list<Order>

Resource URL

https://ecommerce.dexero.com/service/rest/2/merchant/catalog/orders/treated.format

Parameters

Parameter Description
count Indicates the number of records to retrieve. the default 20.
Example Values : 30
offset The offset starting point (0-based) of the first object to return to the list. The default value is 0.
Example Values : 20
sort_key The field on which to sort the returned results. If the field is not present on an input, the value of empty string is used. The default value is purchasedTimestamp.
Example Values : purchasedTimestamp
sort_dir The direction of sorting results. The default is asc.
Example Values : asc, desc
customer_email The customer email to which the purchases are related.
Example Values : customer@dexero.com
earliest_time Filters objects returned by their timestamp. only objects that have a timestamp that is >= earliest_time will be returned. The date format is ISO-8601 formatted
Example Values : 2011-11-25T15:58:50-05:00
latest_time Filters objects returned by their timestamp. only objects that have a timestamp which is <= latest_time will be returned. The date format is ISO-8601 formatted
Example Values : 2011-11-25T15:58:50-05:00
min_id Return the greater than or equal to min_id objects.
Example Values : 10
max_id Return the smaller or equal to max_id objects.
Example Values : 100
include_forms Include forms in response. The default default is false.
Example Values : true
include_tests Allows the inclusion of orders have been reported as a test. The default is false.
Example Values : true
custom_field_identifier Filters objects returned by the presence of the identifier of a custom field. Only objects that have the ID field in the product value will be returned.
Example Values : myfieldid
custom_field_value Filters objects returned by the presence of the value of a custom field. Only objects that have value in a custom product field will be returned.
Example Values : 123
attribute_identifier Filters objects returned by the presence of the identifier of a attribute. Only objects that have the attribute identifier in the product value will be returned.
Example Values : myfieldid
attribute_value Filters objects returned by the presence of the value of a attribute. Only objects that have value in a product attribute will be returned.
Example Values : 123

Example Request

https://ecommerce.dexero.com/service/rest/2/merchand/catalogue/orders/treated.json

Response Object "Order"

Field Data Type Description
id long The unique identification number of this product. ID is automatically generated and can not be changed.
customer_id long The unique identification number of the account
purchase_date Date ISO-8601 The date of purchase
currency string The ISO 3-letter code of the currency
customer_comment text A message left by the customer when ordering
customer_email string The customer email
locale string The ISO language code when ordering
subtotal_order decimal(20,2) Subtotal amount of the order
subtotal_cancelled decimal(20,2) Subtotal amount cancellation
total_order decimal(20,2) Total amount of the order
total_cancelled decimal(20,2) The total amount of cancellation
total_products decimal(20,2) The total amount of products
total_payment decimal(20,2) The total payment
total_refunded decimal(20,2) The refund total
total_transactions decimal(20,2) The total amount of transactions
total_shipping decimal(20,2) The total amount of delivery
total_left_to_pay decimal(20,2) Remaining amount to be paid
total_tax decimal(20,2) Total amount of taxes
total_tax_cancelled decimal(20,2) Total amount of canceled taxes
ip_address string L'adresse IP du client
is_archived boolean Indicates whether the order has been removed (archived).
status string Order Status : treated
is_shippable boolean Determines whether the sale order has products that are deliverable.
transaction_type string Type of transaction.
payment_method string Payment method
payment_provider string The payment provider
card_type string The type of card used in the transaction
reference_number string The reference number of the order
is_test boolean Determines if the order was reported as test
billing_address objet Address The billing address
shipping_address objet Address The delivery address
order_form List<OrderForm> Form datas
product List<OrderProduct> The list of products
customer objet Customer Client Informations

Response Object "Address"

Field Data Type Description
name string The name of the resident at this address
phone_number string The telephone number
postal_code string The postal code
company string The name of the company
street_address string The address
city string The city
iso_country string The ISO country code
iso_region string The ISO code of the region (Province)

Response Object "OrderForm"

Field Data Type Description
title string The title of the form
quantity_number int Number quantity
product_id long The unique identification number of the product. ID is automatically generated and can not be changed.
value List<Value> The list of values ​​entered by the customer

Response Object "OrderProduct"

Field Data Type Description
id long The unique identification number of the product. ID is automatically generated and can not be changed.
sku string Stock Keeping Unit ( SKU )
name string Product name
type enum('buy', 'refund') Type of action related to the product
  • buy - buy
  • refund - refund
product_price decimal(20,2) The price of the product
total_price decimal(20,2) The total price "including the discount"
price_for_quantity decimal(20,2) The price based on the quantity
rebate_amount decimal(20,2) The amount of the discount
tax_amount decimal(20,2) The amount of taxes
quantity int The quantity purchased
custom_param List<CustomParam> The list of values ​​for custom parameters
attribute List<Attribute> The list of attributes

Response Object "Value"

Field Data Type Description
id long The unique identification number of the value. ID is automatically generated and can not be changed.
identifier string The identifier of the form field
label string The label of the form field
value string The value entered by the customer
fileName string File name
fileSizeBytes string File size in bytes
fileContentBase64 string Base64 file (Only if the file is less than 10 megs)

Response Object "CustomParam"

Field Data Type Description
identifier string The identifier of the custom field
value string The value of the custom field

Response Object "Attribute"

Field Data Type Description
identifier string The identifier of the attribute
value string The value entered by the client

Pagination information

Property Description
totalResults The total number of elements in the list.
startIndex The offset starting point (0-based) of the first object to return to the list. The default value is 0.
itemsPerPage The total number of items per page.
pageCount The number of pages.