Type specifications
Response from the API endpoint...
ProductCatalog
Identification
Basic product identification
Stock
Stock of the product (field “Movement” will not be returned)
Price
Price of the product
Kits
If the product is normal, it will return all the kits where this product is included
KitComponents
If the product is a kit, it will return all its components
Publications
Grouped summary of all product listings belonging to the product.
— START PIM SECTION —
The following sections are available for licensed Alephee PIM customers only. Please reach your sales representatives for more information.
— START PIM SECTION —
Product additional data
Complete product data, images, tags, and related information
Attributes
List of product attributes and its values.
Variations
All the product variations products.
Relationships
Relationships of the product with other products.
Complementarians and substitutes products.
— END PIM SECTION —
— END PIM SECTION —
— END PIM SECTION —
ProductIdentification
Id
integer
Alephee ID to identify the product
SKU
string
SKU code that identifies the product
OwnCode
string
The product’s internal CODE (if any) that matches the customer's code in the user's ERP.
Brand
{
"Id": integer,
"Name": string
}
Alephee ID of brand, name of the brand
Name
string
Product name
CatalogStatus
{
"Id": integer,
"Name": string
}
Alephee ID and name of the product status in catalog.
Available values are:
0 = Assigned,
1 = Approved (assigned and approved),
2 = Observed (assigned but observed),
3 = Observed and fixed,
4 = Observed and rejected,
5 = Deleted
ProductType
{
"Id": integer,
"Name": string
}
Alephee ID of the product type, name of the type
1 = Normal,
2 = Kit
KitComponent
Identification
Basic product identification
Price
Price of the product
Stock
Stock of the product (Movement will not be returned)
Quantity
integer
Quantity of the product in the kit
Principal
boolean
Product is principal on the kit
GroupedPublications
Marketplace
{
"Key": integer,
"Value": string
}
Alephee ID of marketplace, name of the marketplace
Details
List of product listings grouped by their status
Publication
Status
{
"Id": integer,
"Name": string
}
Alephee ID of the status, name of the status of the product listing.
Please refer to the product listing status section.
Quantity
integer
Quantity of product listings.
ExternalIds
[
{
"ExternalId": string
}
]
Array of external IDs of product listings grouped by status
ProductStockGet
Quantity
integer?
Get the current product available stock.
B2BQuantity
integer?
Get the current product available stock for the B2B portal.
(Only for Alephee B2B portals)
PublishQuantity
integer?
Get the current product published stock quantity on all product listings.
MinPublicationQuantity
integer?
Get the minimum stock to pause the marketplace’s publications (if any) that belongs to the product.
By default, Alephee pauses the product’s product listings when the stock value reach zero units.
Can only be used when accountID belongs to a seller or official store Alephee’s account type.
MaxPublicationQuantity
integer?
Get the maximum stock to set on the marketplace’s publication.
Can only be used when accountID belongs to a seller or official store Alephee’s account type
Relationships
Collection of available product stock from other accounts related to the current account.
Show availability of stock of products from the wholesaler/brand and other accounts related to the current account.
It is only valid if the calling account is a seller-type account.
Fulfillment
Collection of fulfillment stock details and quantities (if any) for the product listings belonging to the product.
This information is related to all the fulfillment product’s listings in the marketplace.
It is valid only if the seller has products in marketplace fulfillment stock.
Alert
/
Stock alert details.
(Only for Alephee B2B portals)
RelatedProductStockGet
Account
{
"Id": int,
"Name": string
}
Alephee account ID and name of the related account.
Quantity
integer
Get the current product available stock.
ProductPriceGet
Price
decimal?
Price before taxes
PriceWithTaxes
decimal?
Price after taxes
SuggestedRetailPrice
decimal?
Suggested retail price
Cost
decimal?
Cost of the product
(Only for sellers)
B2BDiscountRate
decimal?
Discount rate (in percentage) to be applied into the product price for the Alephee B2B portal.
(Only for wholesalers)
(Only for Alephee B2B portals)
SalesMargin
decimal?
Sales margin to be applied into the price given by the wholesaler.
(Only for sellers)
FinalPriceWithShippingCost
decimal?
Price with taxes and shipping cost
(Only for sellers)
SuggestedRetailPrice AutoCalculated
boolean?
Only for kits. Indicates whether the RetailPrice is auto calculated based on the components’ RetailPrice
(Only for wholesalers)
PriceAutoCalculated
boolean?
Only for kits. Indicates whether the RetailPrice is auto calculated based on the components’ RetailPrice
(Only for wholesalers)
PriceList
{
"Id": int,
"Name": string
"DiscountRate" decimal?
}
Alephee ID, name and the default discount rate of the price list assigned to the product.
Note:
Visible only for wholesalers.
For sellers the name is obfuscated because of regulatory issues.
Relationship
RelationshipType
{
"Key": int,
"Value": string
}
Alephee ID and name of the relationship type.
One product can be related to another product because several following reasons. Key values:
1 = Application/ Compatibility
(Vehicle)
10 = Substitute
20 = Kit
30 = Variation
40 = Proxy
(Alternate product)
50 = Complementary
Items
The list of the related products identifications.
VariationProduct
Identification
Basic product variation identification.
Stock
/
Stock of the product variation.
Attributes
List of product variation attributes and its values.
Principal
bool
Indicates if the variation is the main variation of the parent product.
Please note: Product variations do not contain individual prices. The price is contained only by the main/principal product. However, product variations do contain individual stock.
ProductAdditionalData
Description
string
Product description
Title
string
Product title
AlternateTitle
string
Product alternate title
SearchText
string
Product search text
LogisticTags
List of logistics tags for the product
SalesTags
List of sales tags for the product
MELICategory
string
Mercado Libre defined category for the product
OwnCategory
User own defined categories for the product
Images
List of images for the product
UrlVideo
string
URL/URI of the video attached to the product (if any)
Features
Product features details
ProductAttribute
Name
string
Name of the attribute
Value
string
Vale of the attribute
ValueName
string
Vale name of the attribute
MeasurementUnit
{
"Id": int,
"Name": string
}
The ID and name of the measurement unit.
Mercado Libre defines and changes the name without prior notice.
MeasurementUnitShort
string
Short name of the measurement unit.
ProductTag
Text
string
Tag text/name/description
Items
[string]
Tag values
(Array of)
Delimiter
string
Items tag values delimiter (comma, semicolon, and so on)
ProductImage
UrlThumbnail
string
The complete public URL containing the thumbnail for the image.
UrlImage
string
The complete public URL containing the full-sized image
ProductFulfillmentStock
Marketplace
{
"Key": int,
"Value": string
}
The key and name for the marketplace’s fulfillment warehouse.
See marketplaces ID section and the GET marketplaces endpoint for the coding reference.
Total
integer
The total of available and unavailable stock quantities for fulfillment product listings sales.
AvailableQuantity
integer
The available stock quantity for fulfillment product listings sales.
NotAvailableQuantity
integer
The unavailable stock quantity for fulfillment product listings sales.
NotAvailableDetails
The collection of details/reasons for which there is no stock available.
ProductFulfillmentUnavailable
Quantity
integer
The quantity of unavailable stock.
Status
string
The status/reason of the unavailable stock, according to the origin marketplace.
Possible values for the “Status” attribute are:
withdrawal
The item is in a withdrawal process and awaiting to be delivered.
It is not available for sale.
damaged
The item is damaged.
It is not available for sale.
lost
The item is lost.
It is not available for sale.
noFiscalCoverage
The item has no fiscal coverage.
It is not available for sale.
internal_process
The item temporary reserved for internal warehouse quality process.
It is not available for sale.
transfer
The item is beign transferred to another warehouse.
It is not available for sale.
not_supported
The item is not identifiable or not processable for sale.
Conditions
[
{
"Condition": string,
"Quantity": integer
}
]
Array of conditions and quantities for the unavailable stock.
Possible values for the “Condition” attribute are:
arrived_damaged
damaged
damaged_in_full
expiration_problem
package_problem
flammable
regulation_problem
multiple_identifier
empty_identifier
multiple_sku
invalid_identifier
return_problem
not_supported
dimensions_exceeds
other
ProductFeatures
Visibility
integer?
Sets the product visibility.
(Only for Alephee B2B portals)
Allowed values are:
0 = Product not visible.
1 = Product visible.
2 = Product visible, but not purchasing allowed.
Last updated
Was this helpful?