GetOrder. Through an OrderId, retrieves the items for a single order.
Remember that you can view the available order statuses in the order flows section (Here)
The response fields provided by this API are detailed in the following table:
Field Name | Type | Description |
---|---|---|
OrderId | Unsigned | Identifier of this order assigned by the 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 payment method. |
Remarks | String | A human-readable remark. |
DeliveryInfo | String | Shipping information for the order. |
Price | Float | The total amount of this order. |
GiftOption | Boolean | 1 if the item is a gift, 0 if not. |
GiftMessage | String | Gift message as specified by the customer. |
CreatedAt | DateTime | Date and time when the order was placed. |
UpdatedAt | DateTime | Date and time of the last modification of the order. |
AddressBilling | Subsection | Node containing additional nodes that make up the billing address: First Name, Last Name, Phone, Phone2, Address1, Address2, City, Postal Code, Country. |
AddressShipping | Subsection | Node containing additional nodes that make up the shipping address: First Name, Last Name, Phone, Phone2, Address1, Address2, City, Postal Code, Country. |
NationalRegistrationNumber | String | Required in some countries. |
ExtraAttributes | String | Extra attributes that were passed to the Seller Center in the getMarketPlaceOrders call. \n \nThis is a JSON string that the client must parse. |
ExtraBillingAttributes | String | Node containing additional billing information: LegalId, FiscalPerson, DocumentType, ReceiverRegion, ReceiverAddress, ReceiverPostcode, ReceiverLegalName, ReceiverMunicipality, ReceiverTypeRegimen, CustomerVerifierDigit. |
ItemsCount | Integer | Number of items in the order. |
Statuses | Array | Unique statuses of the order items. (Tip: you can find all the different status codes in the response example). |
OperatorCode | String | Operator type name (Identifies country of operation) e.g.: facl, fape, etc. |
ShippingType | String | Fulfillment and delivery modality of the order ¹. |
InvoiceRequired | Boolean | Returns True if the document is an Invoice, and False if it is a receipt. |
¹ - This field can be used to differentiate the fulfillment modality and add decision rules for the consumption or not of stocks in the inventory management systems of integrators, as shown in the following examples:
- When the ShippingType is Dropshipping, the orders are Fulfilled by the seller so they must consume stock as they are assembled in their own warehouses;
- When the ShippingType is Own Warehouse, these orders are Fulfilled by Falabella and should not consume stock since it has already been delivered to Falabella.com for fulfillment on behalf of the seller.
📘 Receipt or Invoice?
As shown in the previous table, the 'InvoiceRequired' field indicates whether the sale was made using a receipt ('Factura persona natural' in Colombia) or an invoice ('Factura empresa' in Colombia). It will return 'True' if it is an invoice and 'False' if it is a receipt.
If it is an invoice ('Factura empresa' in Colombia), the API will return a series of fields with relevant information for generating the invoice, presented in the following table
Field | Clarification | Description |
---|---|---|
ReceiverLegalName | Business name | Corresponds to the business to which the invoice must be issued. |
ReceiverAddress | Address | Address to which the invoice should be sent. |
ReceiverRegion | Region (Chile) / Department (Peru) / Department (Colombia) | Location where the address is found. |
ReceiverMunicipality | Commune (Chile) / Province (Peru) / City or Municipality (Colombia) | Corresponds to the area in which the address is located. |
FiscalPerson | Taxable person | Identification of the business. |
DocumentType | Document type | Type of identification document for the legal entity. |
LegalId | Legal identification | Corresponds to the number of the document identified in the "Document type" field with a verification digit. |
ReceiverTypeRegimen | Economic activity | Code and name of the activity or industry in which the legal entity operates. |
CustomerVerifierDigit | Verification digit | The verification digit of the "legal identifier." |
ReceiverEmail | Email that should be associated with the invoice. | |
ReceiverPhonenumber | Phone | Phone that should be associated with the invoice. |
Errors
Error Code | Message |
---|---|
16 | E016: "%s" Invalid Order ID (Invalid order ID) |