Alephee developers portal
  • Introduction
    • 📘API documentation
      • Introduction to integrations
    • ⚙️Using the API
      • 🔒Authentication
      • 🏹Swagger
    • 📡Overall index of methods
  • Usage limiting
    • 🕑Rate limiting
    • 🔃Limits per request
    • ♒Limits HTTP headers responses
    • ⚠️Usage limits by endpoint
  • Accounts
    • GET methods
      • Accounts
        • ⚠️Usage limiting
        • ⬆️Request and Respone
        • ⌨️Type specifications
        • ⚙️Examples
      • Marketplaces
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Price Lists
        • ⚠️Usage limiting
        • ⬆️Request and Responses
        • ⌨️Type specifications
        • ⚙️Examples
      • Stores
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Login Token
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • 📊Business rules
        • Standard usage flow for Alephee B2B portal
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update account fiscal tax rules
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
  • Orders
    • Logical model
      • ℹ️What is an order?
      • 📂Order model overview
      • 🛒Shopping cart orders
        • 🔳Cart order model overview
        • 〽️Mercado Libre’s shopping cart orders
      • 💴Approved payments and pending payments
      • 🗒️General notes
    • GET methods
      • 👩‍💻Orders
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
        • ⁉️Useful tips
      • 🛒Orders List From A Shopping Cart
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • 📄Orders Document
        • ⚠️Usage limiting
        • ⬆️Request and Response
      • 🧾Order Shipping Label
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
    • PUT methods
      • 📑Update orders status
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • 👨‍💼Mark orders as integrated
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • 📑Attach document to an order
        • ⚠️Usage limiting
        • Allowed document types and formats
        • ⬆️Request and Response
        • ⚙️Examples
        • ⚙️Example using POSTMAN via form-data
        • ⚙️Example using POSTMAN via JSON body
      • 📑Split an order
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
      • 📨Send a message to a buyer
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
      • 📝Create a new order
        • ⚠️Usage limiting
        • Introduction
        • 📊Business rules
        • 📑Order mandatory sections
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • DELETE methods
      • 📑Delete an order
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⚙️Examples
  • Orders shipping
    • GET methods
      • Shipping Packaging Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Shipping Scheduling Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Shipping Transportation Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Set Shipping Packaging Information
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⚙️Examples
  • Products
    • GET methods
      • Products
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Logical model
      • Business Rules
        • Prices considerations
        • Available prices attributes combinations to set prices
        • Stock considerations
        • Alephee B2B portals prices and stock considerations
        • Measurable quantity and price considerations
      • Update Products
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update product fiscal information
        • ⚠️Usage limiting
        • 🗒️Notes
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • DELETE methods
      • Delete products from a price list
        • ⚠️Usage limiting
        • 📊Business rules
        • ‼️Warnings
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⌨️Result type specifications
        • ⚙️Examples
        • Most common validation error messages and how to fix them.
  • Product listings
    • GET methods
      • Product Listings
        • ⚠️Usage limiting
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • POST methods
      • Set product listings discounts
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
    • PUT methods
      • Update product listings
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
      • Set product listings status
        • ⚠️Usage limiting
        • 📊Business rules
        • ⬆️Request and Response
        • ⌨️Type specifications
        • ⚙️Examples
  • GLOSSARY
    • Conventions
    • Response status codes
    • Marketplaces/Channels ID and names list
    • Product listings status list
    • Orders and shipping glossary
      • Available order statuses codes
      • State transitions diagram
      • Automatic and manual order status updates
      • Attaching documents to orders
      • Shipping labels
  • TROUBLESHOOTING
    • ❗Important tips
    • ✅Best integrations practices
Powered by GitBook
On this page
  • ProductListing
  • ProductListingDeals
  • ProductListingShipping
  • ProductListingProperties

Was this helpful?

  1. Product listings
  2. GET methods
  3. Product Listings

Type specifications

Response from the API endpoint...

ProductListing

Property
Type
Description

Id

integer

ID of the product listing

Brand

string

Brand of the product that is published in the product listing

SKU

string

SKU of the product that is published in the product listing

ProductSKU

string

The SKU of the original product in the catalog. May differ from the previous published SKU identificator.

SellerSKU

String

The product’s internal CODE (if any) that matches the customer's code in the user's ERP.

ExternalId

string

The marketplace-assigned ID for the product listing

Marketplace

{

Key (integer),

Value (string)

}

Marketplace origin of the product listing.

See marketplaces ID section and the GET marketplaces endpoint for the coding reference.

Title

string

Public title of the product listing

Status

{

Key (integer),

Name (string),

UpdatedDateTime (DateTime)

}

Status of the product listing.

Please refer to product listings statuses

PermanentLink

string

The public URL of the product listing

Category

{

Id (string),

Value (string)

}

The identification code and name of the marketplace category where the product listing is published.

ListingType

(Valid only for the Mercado Libre marketplace

{

Id (integer),

Name (string),

Description (string)

}

The marketplace-assigned type for the product listing

Available values are:

0 = no type found

1 = gold_pro

2 = gold_premium

3 = gold_special

4 = gold

5 = silver

6 = bronze

7 = free

The “Description” attribute includes the friendly name of the listing type.

Price

decimal

The published price for the product listing

Deals

The list of marketplace’s IDS of any deals the product listing is currently attached to.

AvailableQuantity

integer

The published available quantity for the product listing

SoldQuantity

integer

The quantity of sales the listing product have

Visits

integer?

The quantity of visits the listing product have

Health

(Only for the Mercado Libre marketplace)

decimal?

The marketplace-assigned health (in percentage) of the product listing.

(Only for the Mercado Libre marketplace)

PicturesQuantity

integer?

The quantity of pictures the listing product have

PicturesList

[string]

List of public URLs of the pictures on the product listing

UrlVideo

string

URL/URI of the video attached to the product (if any)

AttributesQuantity

integer?

The quantity of attributes the listing product have

Shipping

Several flags of the product listing shipping options.

Properties

Several flags of the product listing properties.

Tags

[string]

Collection of tags of the product listing. Each tag is defined by the marketplace and there is no guarantee that the name will remain the same over the time.

Examples of tags:

· ahora-12

· ahora-18

· mandatory_free_shipping

· good_quality_pictures

· immediate_payment

· cart_eligible

ChildProductsList

List of related product listings to this one. This list includes only child-type product listings.

DateCreated

datetime? (UTC with local user time zone)

Date and time of the creation of the product listing.

DateUpdated

datetime? (UTC with local user time zone)

Date and time of the last update of the product listing.

ProductListingDeals

Property
Type
Description

Active

bool

Indicate if the product listing has AT LEAST ONE deal active.

List

bool

The list of marketplace’s IDS of deals the product listing is currently attached to.

ProductListingShipping

Property
Type
Description

Fulfillment

bool

Indicate if the product listing belongs to the marketplace’s fulfillment selling subscription.

MercadoEnvios

bool

Indicate if the product listing belongs to any of the available Mercado Envios shipping type option.

Exclusive for Mercado Libre.

MercadoEnvios1

bool

Indicate if the product listing uses the “ME1” shipping type option.

Exclusive for Mercado Libre.

MercadoEnvios2

bool

Indicate if the product listing uses the “ME2” shipping type option.

Exclusive for Mercado Libre.

Flex

bool

Indicate if the product listing uses the “Flex” shipping type option.

Exclusive for Mercado Libre.

ProductListingProperties

Property
Type
Description

Buybox

bool

Indicate if the product listing belongs to any marketplace “catalog” or “buybox” listing.

Exclusive for Mercado Libre.

HasFiscalInformation

bool

Indicate if the product listing has set the fiscal information. This is done using the “PUT fiscalInformation” endpoint.

Exclusive for Mercado Libre.

Exclusive for Brazil.

PreviousRequest and ResponseNextExamples

Last updated 1 year ago

Was this helpful?

⌨️
ProductListingDeals
ProductListingShipping
ProductListingProperties
ProductListing