⌨️Type specifications
Response from the API endpoint...
OrderInfo
| Property | Type | Description |
|---|---|---|
MarketplaceId * | integer | The marketplace/channel where the order will be assigned.
Please refer to marketplaces/channels list section to see the ID / codes you need to set. |
ExternalOrderId * | string | The external identification number of the order.
Is your own ID number to uniquely identify the order.
|
Integrated | boolean | If ¨true¨ the order will be marked “as integrated” after creation.
Refer to mark order as integrated endpoint.
|
ErpStatus | string | Your internal integrated status. |
DateCreated * | datetime (UTC with local user time zone) | The original date and time when the order was created.
|
Items * | Collection of order’s items. | |
Buyer * | Data of the order’s buyer (buyer or customer or client). | |
Payments * | Collection of order’s payments. | |
Shipping * | Data of the order’s shipping (shipping or delivery). |
OrderInfoItems
| Property | Type | Description |
|---|---|---|
Product * | The product that corresponds to the item of the order.
It should match a product in the product catalog. If not found, a product "disconnected" from the catalog is assumed. | |
Quantity * | integer | The number of units of the product involved in the order item |
StockMovement * | boolean | •When a new order is created, for each one of the items, it is possible to define whether the current inventory/stock in Alephee for that product will be updated. The “StockMovement” attribute in the items section us used for this.
If “StockMovement” attribute is “True” Alephee will update the product’s inventory current value.
If the attribute contains value of “False” no inventory will be updated. |
UnitPrice * | decimal | The individual unit price product involved in the order item.
This value may or may not match the retail price in the product catalog.
The price indicated here takes precedence over the price that corresponds to the product in the catalog.
|
UnitPriceCost | decimal | The individual unit seller’s cost product involved in the order item.
This value may or may not match the retail price in the product catalog.
The price indicated here takes precedence over the price that corresponds to the product in the catalog. |
Status * | integer | The status of the order item. Available values are:
Confirmed = 10 Shipped = 20 Delivered = 80
Please use the integer value.
|
Notes | string | Free notes for the order item. |
OrderInfoItemProduct
| Property | Type | Description |
|---|---|---|
Brand | string | Product brand Should match the brand in the Alephee product catalog.
(please refer to business rules) |
SKU * | string | Product SKU Should match the SKU in the Alephee product catalog.
(please refer to business rules) |
SellerSKU | string | Product own identification code Should match the “OwnCode” in the Alephee product catalog.
(please refer to business rules) |
Title * | string | If you need to associate a product that is not existent in the Alephee catalog, complete this attribute and leave the previous attributes blank.
An order item associated with an "offline" product will be generated with the given title. |
OrderInfoBuyer
| Property | Type | Description |
|---|---|---|
OwnCode | string | Your own code for the selected buyer. |
Name * | string | The name and last name of the buyer. |
string |
| |
DocType * | string | Identification document type. Available document types:
Argentina: DNI, CUIT, LC, LE, Otro. Brazil: CPF, CNPJ. Chile: RUT, Otro. Colombia: CC, CE, NIT, Otro. México: RFC, CURP, Otro. Uruguay: CI, RUT, Otro. Perú: DNI, CE, RUC. Venezuela: CI, RIF, Pasaporte. |
DocNumber * | string | Document number of the buyer. |
Phone * | string | Buyer phone. |
BillingInfo * | Billing information data. | |
Address * | Buyer address.
Maybe will match the shipping address. |
OrderInfoBillingInfo
| Property | Type | Description |
|---|---|---|
DocType * | string | Identification document type. Available document types:
Argentina: DNI, CUIT, LC, LE, Otro. Brazil: CPF, CNPJ. Chile: RUT, Otro. Colombia: CC, CE, NIT, Otro. México: RFC, CURP, Otro. Uruguay: CI, RUT, Otro. Perú: DNI, CE, RUC. Venezuela: CI, RIF, Pasaporte. |
DocNumber * | string | Document number of the billable buyer. |
TaxPayerType * | string | Legal entity type (valid only for companies). Free text.
|
BusinessName | string | Legal business name (valid only for companies) |
Address * | Address for billing purposes. |
OrderInfoAddress
| Property | Type | Description |
|---|---|---|
CountryId * | string | Standarized country code AR, MX, CL, UY, PE, CO or BR |
StateCode * | string | Standarized city code
Please note that the “State” attribute with the full name will be available on the GET order endpoint. |
City * | string | . |
Neighborhood | string | . |
StreetName * | string | . |
StreetNumber | string | . |
ZipCode * | string | . |
Phone * | string | . |
AlternativePhone | string | . |
Description | string | Free notes. |
OrderInfoPayments
| Property | Type | Description |
|---|---|---|
ExternalPaymentId * | string | The external identification number of the payment.
Is your own ID number to uniquely identify the payment.
|
Amount * | decimal | Paid amount (including shipping, financial charges and after any discounts, if any) |
AmountNoDiscount * | decimal | Paid amount before discounts (if any) |
ShippingAmount | decimal | Shipping portion of the paid amount (after discounts, if any) |
ShippingAmountNoDiscount | decimal | Shipping portion of the paid amount before discounts (if any) |
Installments | integer | Installment’s quantity (if any). In general, monthly payments. |
InstallmentAmount | decimal | Amount of each one of the installments (if any). In general, amount of each monthly payment. |
Taxes | Taxes details
(In general, most of the time it is blank) | |
Discounts | Discount collection details.
| |
Method | integer | The method used in the payment. Available values are:
Account_money = 0, //Money in the MercadoPago account
Ticket = 1 //Printed ticket
Bank_transfer = 2 //Wire transfer
Atm = 3 //Payment by ATM
Credit_card = 4 //Payment by credit card
Debit_card = 5 //Payment by debit card
Prepaid_card = 6 //Payment by prepaid card
Digital_currency = 7
Digital_wallet = 8
Cash = 99 //Cash
Please use the integer value. |
Status * | integer | The status of the payment. Available values are:
pending = 0 //El usuario aún no completó el proceso de pago
approved = 1 //El pago fue aprobado y acreditado
in_process = 2 // El pago está siendo revisado.
in_mediation = 3 //Los usuarios tienen iniciada una disputa
rejected = 4 // El pago fue rechazado. El usuario puede intentar pagar nuevamente.
cancelled = 5 //El pago fue cancelado por una de las partes, o porque el tiempo expiró
refunded = 6 // El pago fue devuelto al usuario.
charged_back = 7 // Fue hecho un contracargo en la tarjeta del pagador. Please use the integer value. |
DateCreated * | datetime (UTC with local user time zone) | Informational only. |
DateApproved * | datetime (UTC with local user time zone) | Informational only. |
Notes | string | Free notes |
OrderInfoPaymentTaxes
| Property | Type | Description |
|---|---|---|
Amount | decimal | The amount of taxing involved in the payment. |
OrderInfoPaymentDiscount
| Property | Type | Description |
|---|---|---|
Code* | string | The given discount code type for the applied discount. Available values are: • Coupon • Discount • Cashback • Voucher • Redeem |
Type* | string | The discount value type. Allowed values are: • Value (single amount) • Percentage |
Amount * | decimal | The monetary amount of the applied discount. • Positive decimal numbers means a discount. • Negative decimal numbers means a surcharge/recharge.
|
Value * | decimal | The amount of the discount, depending on the “type” value type. • Positive decimal numbers means a discount. • Negative decimal numbers means a surcharge/recharge. |
Priority | string | The order of priority in which the discount should be applied |
Notes | string | Free notes |
OrderInfoShipping
| Property | Type | Description |
|---|---|---|
ExternalShippingId * | integer | The external identification number of the shipping.
Is your own ID number to uniquely identify the shipping.
|
Method * | integer | The method used for the order shipping. Available values are:
AgreementWithSeller = 0 //Seller and buyer agreed where to ship the package
Pickup withdraw = 2 //The buyer picks up the order at the seller's branch or pickup point
Normal Shipping = 4 //Normal shipping to a selected address
Please use the integer value. |
LogisticType * | integer | The logistics type of the order shipping. Available values are:
To_be_agreed = 1 ME1 = 2 ME2 = 3 Custom = 4 Fulfillment = 5 Flex = 6 Pickup = 7 Cross_docking = 8 Courier = 14
Please use the integer value. |
CourierInfo ** | The courier that collects and delivers the order.
Mandatory only if the LogisticType attribute is set to value “14”.
| |
Cost | The shipping costs (if any) of the order.
| |
Receiver ** |
| Receiver data and address.
Always mandatory except if the Method attribute is set to value “2”.
|
Pickup ** | The pickup or branch information where the buyer will withdraw the package.
Mandatory only if the Method attribute is set to value “2”.
| |
EstimatedDeliveryDate * | datetime (UTC with local user time zone) | Informational only. |
DateCreated * | datetime (UTC with local user time zone) | Informational only. |
OrderInfoCourier
| Property | Type | Description |
|---|---|---|
BusinessName * | string | Legal business name |
DocType | string | Identification document type. Available document types:
Argentina: DNI, CUIT, LC, LE, Otro. Brazil: CPF, CNPJ. Chile: RUT, Otro. Colombia: CC, CE, NIT, Otro. México: RFC, CURP, Otro. Uruguay: CI, RUT, Otro. Perú: DNI, CE, RUC. Venezuela: CI, RIF, Pasaporte. |
DocNumber | string | Document number of the courier. |
LegalNumber | string | Legal inscription number of the courier. |
OwnCode | string | The courier’s internal CODE (if any) that matches the code in the user's ERP. |
Address | Address of the courier |
OrderInfoShippingCost
| Property | Type | Description |
|---|---|---|
Seller * | decimal | The shipping cost (if any) that the seller of the order should pay.
If none, set this property to 0.00 (zero). |
Receiver * | decimal | The shipping cost (if any) that the receiver/buyer of the order should pay.
If none, set this property to 0.00 (zero). |
Total * | decimal | Total and complete shipping cost (if any) of the order. Should match seller + receiver costs.
If none, set this property to 0.00 (zero). |
OrderInfoShippingReceiver
| Property | Type | Description |
|---|---|---|
Name * | string | The name and last name of the receiver of the order. |
Phone | string | The phone number of the receiver of the order. |
Address | The receiver address. The location to deliver the order. |
OrderInfoShippingPickup
| Property | Type | Description |
|---|---|---|
Id * | integer | The ID number of the pickup point. Should match Alephee internal ID of the pickup list for the given account.
Use the GET stores endpoint to find the ID for every pickup. |
Name | string | Name of the pickup point. Informational only. |
BusinessName | string | BusinessName of the pickup point. Informational only. |
Last updated