GetDocument

get

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

Retrieve order-related documents: Invoices, Shipping Labels and Shipping Parcels.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

To reconstruct the file the data from the <File> node needs to be base64 decoded. Identifier of the order item for which the caller is wanting to get a document. Mandatory

Errors

Error code	Message
20	E020: "%s" Invalid Order Item IDs
21	E021: OMS Api Error Occurred
32	E032: Document type "%s" is not valid
34	E034: Order Item must be packed. Please call setStatusToReadyToShip before
35	E035: "%s" was not found

Query Params

Action

string

Defaults to GetDocument

Name of the function that is to be called. Mandatory and must be 'GetDocument' 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.

DocumentType

string

One of 'invoice', 'exportInvoice', 'shippingLabel', 'shippingParcel', 'carrierManifest', or "serialNumber". Mandatory. If omitted, or if an unsupported document type is supplied, an error 'E032: Document type "[supplied type]" is not valid'.

OrderItemIds

array of int32s

Identifier of the order item for which the caller is wanting to get a document. Mandatory. GetOrderItems.

OrderItemIds

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Errors

200200

400400