Marketplace-assigned ID of the order.
Not valid for Alephee B2B portal orders.
| | PackId | string |Shopping cart number associated with the order. Only if the order is part of a shopping cart purchase.
Only for the Mercado Libre marketplace. Please refer to the above notes.
| | ~~SourcePackId~~ | ~~string~~ |The original shopping cart number associated with the order. Only if the order is part of a shopping cart purchase.
Only for the Mercado Libre marketplace. Please refer to the above notes.
| | IsCompletePackOrder | bool? |When TRUE, the order is a shopping cart purchase and all items in the cart are present and available for download.
When FALSE, the order is a shopping cart purchase and NOT all items in the cart are present and available for download. You need to wait a while for all the items in the cart to arrive from the marketplace of origin and try to download the order again.
If the attribute is not included or visible in the order, this is NOT a purchase from a package in the shopping cart.
Please refer to the "PackId" attribute.
List of adjustments made in the order. (If any)
Valid only for Alephee B2B portal orders.
| | Shipping | [#shipping](#shipping "mention") | Shipping details | | Buyer | [#buyer](#buyer "mention") | Buyer details | | Billing | [#billing](#billing "mention") | Marketplace-regarding order billing information | | Documents | [#document](#document "mention") |
Array or collection of all the documents attached by the user to the order with all the relevant attributes.
Please note the document-content is not included. You must use the GET orders/document endpoint in order to acquire the document content.
| | ActiveClaims | [#activeclaims](#activeclaims "mention") |List of claims.
Marketplace ID of the claim, Date the claim was created
| | Notes | string | Order additional notes (if any) | | Status |{
Key (integer),
Value (string)
}
{
Key (integer),
Value (string)
}
Current status type of the order.
0 = New
1 = Pending
2 = Closed
99 = Cancelled
| | Marketplace |{
Key (integer),
Value (string),
Channel (string)
}
ID of the marketplace in which the order originated.
See marketplaces ID section and the GET marketplaces endpoint for the coding reference.
The "Channel" property is available on the following scenarios:
The sellers’s internal CODE (if any) that matches the customer's code in the user's ERP.
| ### Item *** | Property | Type | Description | | -------------------------------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Id | integer | Alephee ID to identify the order item | | **Type** |
{
Key (integer),
Value (string)
}
The item types. Available values are:
• Key = 0, Value = “Product”
(The item is a single product)
• Key = 1, Value = “Kit”
(The item is a Kit and a container for other components items)
• Key = 2, Value = “Component”
(The item is a component of a kit)
| | ParentItemId | integer? | In the items of type “Component”, this field identifies the corresponding item of type “Kit” this component belongs to. | | Product | [#product](#product "mention") | Product details | | ProductListing | [#productlisting](#productlisting "mention") | Product listing details | | Quantity | integer | Item quantity | | QuantitiesDetails | [#itemquantities](#itemquantities "mention") |Item quantities details and disaggregation.
| | SaleFee | decimal? | Item marketplace-informed sale fee. | | UnitPrice | decimal | Item unit price | | FullUnitPrice | decimal | Complete pricing of the item without applying any changes for promotions, deals or other discounts. | | Status |
{
Key (integer),
Value (string)
}
{
Key (integer),
Value (string)
}
Current status type of the order item.
Available StatusType key, values:
0 = New,
1 = Pending,
2 = Closed,
99 = Cancelled
| | IsCancelled | boolean | Indicates whether the order item was cancelled or not | | CalculatedComponentUnitPrice | decimal |In the items of type “Component”, this field indicates its unit price within the kit, based on the final price the kit was sold at.
| | CalculatedComponentFullUnitPrice | decimal | In the items of type “Component”, this field indicates its unit price within the kit, based on the final price the kit was sold at, surpassed on the complete pricing of the item without applying any changes for promotions, deals or other discounts. | #### **ItemQuantities** *** | Property | Type | Description | | ------------------------ | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | |
Requested
|
{
Value (decimal),
Measure (string)
}
The requested (from the buyer) quantity and measure of the item on this order.
The measure indicates the measure unit (“unit”, “kg”, “gr”, “tons”)
The value indicated the weight in the given unit.
This attribute is completed only for the Mercado Libre marketplace.
| | Picked |{
Value (decimal),
Measure (string)
}
The picked (from the picking process on the marketplace) quantity and measure of the item on this order.
The measure indicates the measure unit (“unit”, “kg”, “gr”, “tons”)
The value indicated the weight in the given unit.
This attribute is completed only for the Mercado Libre marketplace.
| | StockMovements | [#itemquantitiesstockmovement](#itemquantitiesstockmovement "mention") |Collection of stock movements.
Provides information about the stock movement of the item order in the product catalog stock.
| #### **ItemQuantitiesStockMovement** *** | Property | Type | Description | | ---------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | Account | AccountType | The account information where the product stock movement was processed. | | Quantity | integer | The number of units of the product stock movement | | PrevStock | integer | Available quantity of units of the product stock AFTER the stock movement. | | PostStock | integer | Available quantity of units of the product stock BEFORE the stock movement. | | MinPublicationQuantity | integer? | Provides the product’s minimum publication quantity, that is set to the account (referenced above) that moved stock quantities. | | MaxPublicationQuantity | integer? | Provides the product’s maximum publication quantity, that is set to the account (referenced above) that moved stock quantities. | | DateCreated | datetime (UTC with local user time zone) | Date and time of the stock movement. | #### Product *** | Property | Type | Description | | --------------- | -------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------- | | Id | integer | Alephee ID to identify the product | | SKU | string | SKU code that identifies the product | | Brand | string | Product brand name | | SellerSKU | string | Your internal SKU code indicated for the product (if any) | | EAN | string | EAN that identifies the product | | Attributes | / | Product attributes that are related to the order | | Title | string | Product title | | IntegrationCode | string | Publication identifier of each Marketplace | | Category |{
Key (string),
Value (string)
}
{
Value (decimal),
Measure (string)
}
The net weight of the product.
The measure indicates the measure unit (“kg”, “gr”, “tons”)
The value indicated the weight in the given unit.
This attribute is completed only for the Mercado Libre marketplace, and it is valid for products that are weighed with units of measure.
| | SalesTag | ProductTagType | Product sales tags that are related to the order. | #### ProductListing *** | Property | Type | Description | | ------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Reference | string |The product listing reference type. Available values are:
· “None”: It means that the publication corresponds to the sold product referenced in the order item.
· “Parent”: It means that the publication corresponds to another product that is the parent of the current product. Usually used in the case of KIT components. A component does not have an associated product listing, but the KIT that contains it does.
| | Id | integer | Internal ID of the product listing. | | ExternalId | string | External marketplace-defined ID of the product listing. | | Title | string | Title of the product listing. | |
ListingType
(Valid only for
the Mercado Libre marketplace)
|{
Key (integer),
Value (string),
Description (string)
}
The marketplace-assigned type for the product listing.
Available KEY, VALUE is:
0 = no type found
1 = gold\_pro
2 = gold\_premium
3 = gold\_special
4 = gold
5 = silver
6 = bronze
7 = free
Each one of the above types mean different types of products listings on each country.
The description attribute gets the friendly name of the product listing type. Example: “Clásica”, “Premium”, “Gratis”.
| | PermanentLink | String | Public URL for the product listing. | ### **Payment** ***
| Property | Type | Description |
|---|---|---|
| ExternalPaymentId | string | Marketplace ID of the payment |
| Amount | decimal | Paid amount (including shipping, financial charges and after any discounts, if any) |
| AmountNoDiscount | decimal | Paid amount before discounts (if any) |
| TransactionAmount | decimal | Transactional amount of the order (without discounts, taxes, installments, or any other financial charges). This should match the product pricing. |
| ShippingAmount | decimal | Shipping portion of the paid amount (after discounts, if any). Shows only the sellers'paid amount. Do not includes the buyer's paid amount. |
| ShippingAmountNoDiscount | decimal | Shipping portion of the paid amount before discounts (if any). Shows only the seller's paid amount. Do not includes the buyer's paid amount. |
| Discounts | [#discount] | Array of orders's discount details |
Total
(Only for PedidosYa marketplace) | decimal? | Payment total (Only for PedidosYa marketplace) |
SubTotal
(Only for PedidosYa marketplace) | decimal? | Payment subtotal (Only for PedidosYa marketplace) |
| Installments | integer? | Installment’s quantity (if any). In general, monthly payments. |
| InstallmentAmount | integer? | Amount of each one of the installments (if any) |
| Notes | string | Payment notes |
| AuthorizationCode | string | Payment authorization code |
| CurrencySymbol | string | Currency symbol |
| Method |
| Payment method. • account_money = 0, (MercadoPago account) • ticket = 1, • bank_transfer = 2, • atm = 3, (Payment via ATM machine) • credit_card = 4, • debit_card = 5, • prepaid_card = 6, • digital_currency = 7, • cash = 99, •other = 100 |
| Status |
| Payment status. Status value, Status Key: • pending = 0, • approved = 1, • in_process= 2, • rejected = 4, • cancelled = 5, • refunded = 6, • charged_back = 7 |
| Condition |
| The order’s payment selected condition. Valid only for Alephee B2B portal orders. Condition key, Condition value: • 0 = No information given, • 1 = Payment on credit, • 2 = Payment on advance |
| Taxes |
| Taxes details
(In general, most of the time it is blank) |
| Interests | decimal? | Interests applied to the payment (if any), as reported by the marketplace. In general, these are interest charges for credit card installment payments. The interest applied to the payment ONLY AFFECTS THE BUYER and does not affect the seller in any way. In some countries (such as Brazil) it is required to disclose the interest paid by the buyer on the electronic invoice. |
| DateCreated | datetime (UTC with local user time zone) | Date and time the payment was created |
| DateApproved | datetime (UTC with local user time zone) | Date and time the payment was approved |
| LastUpdate | datetime (UTC with local user time zone) | Date and time the payment was last updated |
The marketplace discount code type for the applied discount. Available values are:
• Coupon
• Discount
• Cashback
• Voucher
• Redeem
• Other
(none of above values)
The discount value type.
Allowed values are:
• Value (single amount)
• Percentage
The monetary amount of the applied discount.
• Positive decimal numbers means a discount.
• Negative decimal numbers means a surcharge/recharge.
The amount of the discount, depending on the “type” value type.
• Positive decimal numbers means a discount.
• Negative decimal numbers means a surcharge/recharge.
{
Amount: decimal,
Value: decimal }
{
Amount: decimal,
Value: decimal }
Total and complete shipping cost (if any) of the order.
| | **SellerCost** | decimal? |
The shipping cost (if any) that the seller of the order should pay.
| | **ReceiverCost** | decimal? | The shipping cost (if any) that the receiver/buyer of the order should pay. | | Method |
{
Key (string),
Value (string)
}
Method type, Method name:
0 = Agreement,
1 = DropShipping,
2 = ClientPickup,
3 = MarketplaceShipping,
4 = OwnShipment,
5 = ThirdPartyShipping
| | Status |{
Key (integer),
Value (string)
}
{
Key (integer),
Value (string)
}
|LogisticType, LogisticName:
1 = to\_be\_agreed,
2 = me1,
3 = me2,
4 = custom,
5 = fulfillment,
6 = flex,
7 = pickup
8 = cross\_docking,
14 = courier
| | CourierInfo | [#courier](#courier "mention") |The courier’s information that collects and deliver the order.
Valid only when LogisticType attribute is value “14”.
| | Receiver |{
Name (string),
Phone (string)
}
Identification document type.
Available document types:
Argentina: DNI, CUIT, CUIL, LC, LE, Otro.
Brazil: CPF, RG, CNPJ.
Chile: RUT, Otro.
Colombia: CC, CE, NIT, Otro.
Ecuador: CI, RUC, Otro.
México: RFC, CURP, Otro.
Perú: DNI, CE, RUC.
Uruguay: CI, RUT, Otro.
Venezuela: CI, RIF, Pasaporte, Otro.
| | 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](#address "mention") | Address of the courier | #### Pickup *** | Property | Type | Description | | ---------------- | ------- | ----------------------------------------------------- | | Id | integer | Alephee ID to identify the Pickup | | Name | string | Pickup name | | BusinessName | string | Pickup legal business name (valid only for companies) | | ExternalPickupId | string | Marketplace ID of the pickup | | IntegrationCode | string | Your internal code indicated for the pickup (if any) | | SellerAccountId | integer | Alephee account ID associated to the pickup (if any) | ### Address *** | Property | Type | Description | | ---------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------- | | CountryId | string |Standarized country code
AR, MX, CL, UY, PE, CO or BR
| | StateCode | string |Standarized city code
| | State | string | . | | City | string | . | | Neighborhood | string | . | | StreetName | string | . | | StreetNumber | string | . | | ZipCode | string | . | | Notes | string | Buyer comments (if any) | | Description | string | Complete address | | Phone | string | . | | AlternativePhone | string | . | ### Buyer *** | Property | Type | Description | | ----------- | ------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Name | string | . | | Phone | string | . | | Email | string | . | | Nickname | string | Nickname or alias (depends on each marketplace) | | Code | integer | The buyer's code (if any) | | OwnCode | string |The buyer's internal CODE (if any) that matches the customer's code in the user's ERP.
Valid only for Alephee B2B portal orders.
| | DocType | string |Identification document type.
Available document types:
Argentina: DNI, CUIT, CUIL, LC, LE, Otro.
Brazil: CPF, RG, CNPJ.
Chile: RUT, Otro.
Colombia: CC, CE, NIT, Otro.
Ecuador: CI, RUC, Otro.
México: RFC, CURP, Otro.
Perú: DNI, CE, RUC.
Uruguay: CI, RUT, Otro.
Venezuela: CI, RIF, Pasaporte, Otro.
| | DocNumber | string | Document number | | BillingInfo | [#buyerbillinginfo](#buyerbillinginfo "mention") | Billing information details | | Address | [#address](#address "mention") | Buyer address details. It may or may not match the shipping address of the order. | #### BuyerBillingInfo *** | Property | Type | Description | | ------------------- | ---------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DocType | string |Identification document type.
Available document types:
Argentina: DNI, CUIT, CUIL, LC, LE, Otro.
Brazil: CPF, RG, CNPJ.
Chile: RUT, Otro.
Colombia: CC, CE, NIT, Otro.
Ecuador: CI, RUC, Otro.
México: RFC, CURP, Otro.
Perú: DNI, CE, RUC.
Uruguay: CI, RUT, Otro.
Venezuela: CI, RIF, Pasaporte, Otro.
| | DocNumber | string | Document number | | TaxPayerType | string |Legal entity type (valid only for companies). string values are subject to change without prior Mercado Libre notice.
Possible values:
Mercado Libre Argentina:
- Monotributo
- IVA Responsable Inscripto
- IVA Exento
Mercado Livre Brazil:
- Contribuinte
- Não contribuinte
| | StateRegistration | [#buyerstatereg](#buyerstatereg "mention") |Buyer state registration identification. Could be blank.
Valid only for the Mercado Livre Brazil marketplace.
| | GeneralRegistration | [#buyergeneralreg](#buyergeneralreg "mention") |Buyer general registration identification.
Valid only for Brazil.
May be blank or null, depending on what the marketplace report.
Billing address details. It may or may not match the buyer's address.
| #### BuyerStateReg *** | Property | Type | Description | | --------- | ------ | ---------------------------------------------------------------------------------------------------------------------- | | DocType | string |
Buyer state registration type. Available values are:
The buyer state registration identification document number.
| #### BuyerGeneralReg *** | Property | Type | Description | | --------- | ------ | ------------------------------------------------------------------------------------------------------------------------ | | DocType | string |
Buyer general registration type. Available values are:
The buyer general registration identification document number.
| #### ShippingLabels *** | Property | Type | Description | | ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ShippingLabelUrlPDF | string | Shipping label to be printed URL (if any), in PDF format | | ShippingLabelUrlZIP | string | Shipping label to be printed URL (if any), in ZIP format, containing a TXT file for Zebra printers | | **Substatus** | string |
Shipping label substatus. Possible values:
· pending
· stale
· ready\_to\_print
· invoice\_pending
· in\_hub
· waiting\_for\_label\_generation
· printed
· waiting\_for\_carrier\_authorization
· ready\_for\_pickup,
· picked\_up
· buffered
When substatus is “ready to print” or “printed” the client can obtain the definitive labelURL properties.
| ### Billing *** | Property | Type | Description | | -------- | ---------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | SaleFee | decimal? |
Order total sale fee.
This value matches the sum of individual items sale fee.
| | Invoice |{
DanfePdfUrl (string),
XmlUrl (string)
}
Electronic invoice information.
(Only for the Mercado Libre marketplace and Brazilian accounts)
DanfePdfUrl includes the DANFE PDF file location.
XmlUrl includes the NFE-Model 55 XML file location.
| ### Document *** | Property | Type | Description | | ------------ | ---------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Type | integer |The order-attached document type. Available values are:
0 = Invoice
1 = Receipt
2 = Electronic fiscal invoice
(Only for Brazil)
7 = Shipping label (not available yet)
| | Name | string | The user-assigned document name. | | Fullfilename | string | The document full filename | | Extension | string | The document full filename extension | | Size | integer | The document file size | | DocumentDate | datetime (UTC with local user time zone) | The user-assigned document date. | | DateCreated | datetime (UTC with local user time zone) | The date and time when user attached the document. | | Number | string |Available only for document type=2 (Electronic fiscal invoice)
The fiscal invoice number.
| | SerialNumber | string |
Available only for document type=2 (Electronic fiscal invoice)
The fiscal invoice series number.
| | FiscalKey | string |
Available only for document type=2 (Electronic fiscal invoice)
The fiscal invoice fiscal key
| #### ActiveClaims *** | Property | Type | Description | | --------------- | ---------------------------------------- | -------------------------- | | ExternalClaimId | string | The ID of the claim | | DateCreated | datetime (UTC with local user time zone) | Datetime of claim creation | ### Adjustment *** | Property | Type | Description | | ----------- | -------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | Type |{
Key (integer),
Value (string)
}
Adjustment type, Adjustment name:
0 = No information given.
Could not find what type of adjustment was made on the order
1 = Pricing adjustment.
A price adjustment typically occurs when a promotion, coupon, discount, or similar is applied to an order.
2 = Inventory adjustment.
An inventory adjustment typically occurs when the seller changes the quantities of products requested in the order.
3 = Quantity adjustment.
A quantity adjustment typically occurs when a promotion is applied that modifies the quantities requested in the order.
4 = Availability adjustment
An availability adjustment typically occurs when the seller modifies the delivery time of the order.
| | Code | string |The code of the element that made the adjustment
| | Description | string |
The description of the element that made the adjustment
| | Item |
| The item/product in the order that was affected by the adjustment. | | Value |
| The value that was affected by the adjustment. | #### AdjustmentItem *** | Property | Type | Description | | --------- | ------- | --------------------------------------------------------- | | Id | integer | Alephee ID to identify the product | | Brand | string |
Product brand name
| | SKU | string | SKU code that identifies the product | | SellerSKU | string | Your internal SKU code indicated for the product (if any) | #### AdjustmentValue *** | Property | Type | Description | | -------- | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | Type |
{
Key (integer),
Value (string)
}
Adjustment value type,
Adjustment value name:
0 = No information given.
Could not find what type of adjustment was made on the order
1 = Percentage over price adjustment.
A percentage over price adjustment.
2 = Fixed price amount adjustment.
A fixed price adjustment.
| | Value | decimal |
The applied value.
(It depends on the type above)
|