GetOrders

get

https://sellercenter-api.linio.com.mx/?Action=GetOrders

Get the customer details for a range of orders.
Substantially different from GetOrder, which retrieves the order items for an order.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…


TotalCount	Unsigned	Displayed in the Head section, this number tells the complete number of all orders for the current filter set in the database
OrderId	Unsigned	Identifier of this order as assigned by Seller Center.
CustomerFirstName	String	The customer's first name.
CustomerLastName	String	The customer's last name.
OrderNumber	Unsigned	The human-readable order number.
PaymentMethod	String	The method of payment.
Remarks	String	A human-readable remark.
DeliveryInfo	String	Delivery information for that order
Price	Float	The total amount for this order.
GiftOption	Boolean	1 if item is a gift, 0 if it is not
GiftMessage	String	Gift message as specified b the customer.
CreatedAt	DateTime	Date and time when the order was placed.
UpdatedAt	DateTime	Date and time of last change to the order.
AddressBilling	Subsection	Node that contains additional nodes, which make up the billing address: FirstName, LastName, Phone, Phone2, Address1, Address2, City, PostCode, Country
AddressShipping	Subsection	Node that contains additional nodes, which make up the shipping address: FirstName, LastName, Phone, Phone2, Address1, Address2, City, PostCode, Country
NationalRegistrationNumber	String	Required in some countries.
ItemsCount	Integer	Number of items in order.
Statuses	Array	Unique statuses of the items in the order. (hint: you can find all of the different status codes in the response example)
PromisedShippingTimes	DateTime	Target shipping time for the soonest order item if they were available
ExtraAttributes	String	Extra attributes which were passed to Seller Center on getMarketPlaceOrders call. It is JSON string which client should parse it.

Errors

Error code	Message
14	E014: "%s" Invalid Offset
17	E017: "%s" Invalid Date Format
19	E019: "%s" Invalid Limit
36	E036: Invalid status filter
74	E074: Invalid sort direction.
75	E075: Invalid sort filter.

Query Params

Action

string

Defaults to GetOrders

Name of the function that is to be called. Mandatory and must be 'GetOrders' in this case. If omitted, an 'E001: Parameter Action is mandatory' error is returned. If an unknown function string is supplied, an 'E008: Invalid Action' error message is returned.

Format

string

Defaults to XML

If supplied, must be either 'JSON' or 'XML'. If not supplied, 'XML' is assumed.

Timestamp

date

The current time in ISO8601 format relative to UTC (e.g., Timestamp=2015-04-01T10:00:00+02:00 for Berlin), so that calls cannot be replayed by an eaves-dropping third party (i.e., those calls too far into the past or future yield an error message). Mandatory. If not supplied, an 'E001: Parameter Timestamp is mandatory' error message results. If the timestamp is too old or in the future, an 'E003: Timestamp has expired' error message is returned.

UserID

string

The ID of the user making the call. The list of authorized users is maintained in Seller Center web interface under Settings/Manage Users.

Version

string

The API version against which this call is to be executed, in major-dot-minor format. Must currently be 1.0, even though the actual version of the API is 2.6.20. If omitted, an ‘E001: Parameter Version is mandatory’ error message is returned.

Signature

string

The cryptographic signature, authenticating the request. A caller must create this value by computing the SHA256 hash of the request, using the API key of the user specified in the UserID parameter. Mandatory. If omitted, an ‘E001: Parameter Signature is mandatory’ error message is returned. If the signature is incorrect, an ‘E007: Login failed. Signature mismatch’ error message is returned.

CreatedAfter

date

Limites the returned order list to those created after or on a specified date, given in ISO 8601 date format. Either CreatedAfter or UpdatedAfter are mandatory or else an error 'E018: Either CreatedAfter or UpdatedAfter is mandatory' wil be returned.

CreatedBefore

date

Limites the returned order list to those created before or on a specified date, given in ISO 8601 date format. Optional

UpdatedAfter

date

Limites the returned order list to those updated after or on a specified date, given in ISO 8601 date format. Either UpdatedAfter or CreatedAfter are mandatory or else an error 'E018: Either CreatedAfter or UpdatedAfter is mandatory' wil be returned. Note: The updateAfter is not related with order updateAt, but related to the sales order item history createAt. In Version 2.0 it uses Order Address Updated At not the order item history.

UpdatedBefore

date

Limites the returned order list to those updated before or on a specified date, given in ISO 8601 date format. Optional. Note: The updateBeore is not related with order updateAt, but related to the sales order item history createAt. In Version 2.0 it uses Order Address Updated At not the order item history.

Limit

int32

The maximum number of orders that should be returned, default 1000

Offset

int32

Numer of orders to skip at the beginning of the list (i.e., an offset into the result set; toghether with the Limit parameter, simple resultset paging is possible; if you do page through results, note that the list of orders might change during paging).

Status

string

When set, limits the returned set of orders to loose orders, which Return only entries which fit the status provided. Possible values are pending, canceled, ready_to_ship, delivered, returned, shipped and failed.

SortBy

string

Allows to choose the sorting column. Possible values (created_at, updated_at). In version 2.0 it is fixed to updated_at and cant be changed

SortDirection

string

Specify sort type. Possible values (ASC, DESC)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Errors

200200

400400