GetOrders. Retrieves a set of orders
Filters can be generated, for example, by date, number of orders (default is 100), and status. Remember that you can see 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 |
|---|---|---|
| TotalCount | Unsigned | This number, shown in the Head section, indicates the total number of all orders for the current filter set in the database |
| OrderId | Unsigned | Identifier of this order assigned by Falabella 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 | Information about the delivery of this 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 the order was placed |
| UpdatedAt | DateTime | Date and time of the last order modification |
| 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 |
| ItemsCount | Integer | Number of items in order |
| Statuses | Array | Unique statuses of the items in the order (hint: you can find all the different status codes in the response example) |
| PromisedShippingTimes | DateTime | Target shipping time for the fastest item in the order if available |
| ExtraAttributes | String | Extra attributes passed to Falabella Seller Center in the getMarketPlaceOrders call. It 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 |
| ShippingType | String | Fulfillment and delivery mode of the order. ¹ |
| InvoiceRequired | Boolean | Returns True ('Factura empresa' in Colombia) if the document is an invoice, and False if it is a receipt ('Factura persona natural' in Colombia). |
¹ - This field can be used to differentiate the fulfillment mode and add decision rules for stock consumption in integrators' inventory management systems, as shown in the following examples:
- When ShipmenType is Dropshipping, orders are Fulfilled by the seller, so they should consume stock as they are prepared in their own warehouses;
- When ShipmenType is Own Warehouse, these orders are Fulfilled by Falabella and should not consume stock because it has already been delivered to Falabella.com for fulfillment on behalf of the seller.
Receipt or Invoice?
As shown in the table above, the 'InvoiceRequired' field indicates whether the sale was made with 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 billing, presented in the following table.
| Field | Clarification | Description |
|---|---|---|
| ReceiverLegalName | Legal entity name | Refers to the business to be invoiced. |
| ReceiverAddress | Address | Address for invoicing. |
| ReceiverRegion | Region (Chile) / Department (Peru) / Department (Colombia) | Location of the address |
| ReceiverMunicipality | Commune (Chile) / Province (Peru) / City or Municipality (Colombia) | Zone where the address is located |
| FiscalPerson | Fiscal person | Identification of the business |
| DocumentType | Document type | Type of identification document of the taxpayer role of the legal entity. |
| LegalId | Legal ID | Number of the document identified in the 'Document Type' field with verifier digit |
| ReceiverTypeRegimen | Economic activity | Code and name of the activity or industry of the legal entity. |
| CustomerVerifierDigit | Verifier digit | Verifier digit of the 'legal identifier'. |
| ReceiverEmail | Email to associate with the Invoice | |
| ReceiverPhonenumber | Phone | Phone number to associate with the Invoice |
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. |