Products
Products API
Documentación de la API de products
Servidor base: https://services.leadconnectorhq.com
Endpoints
- POST /products/bulk-update — Bulk Update Products
- POST /products/bulk-update/edit — Bulk Edit Products and Prices
- POST /products/{productId}/price — Crear Price for a Product
- GET /products/{productId}/price — Listar Prices for a Product
- GET /products/inventory — Listar Inventory
- POST /products/inventory — Actualizar Inventory
- GET /products/{productId}/price/{priceId} — Obtener Price by Id for a Product
- PUT /products/{productId}/price/{priceId} — Actualizar Price by Id for a Product
- DELETE /products/{productId}/price/{priceId} — Eliminar Price by Id for a Product
- GET /products/store/{storeId}/stats — Fetch Product Store Stats
- POST /products/store/{storeId} — Action to include/exclude the product in store
- POST /products/store/{storeId}/priority — Actualizar product display priorities in store
- GET /products/collections — Fetch Product Collections
- POST /products/collections — Crear Product Collection
- GET /products/collections/{collectionId} — Obtener Details about individual product collection
- PUT /products/collections/{collectionId} — Actualizar Product Collection
- DELETE /products/collections/{collectionId} — Eliminar Product Collection
- GET /products/reviews — Fetch Product Reviews
- GET /products/reviews/count — Fetch Review Count as per status
- PUT /products/reviews/{reviewId} — Actualizar Product Reviews
- DELETE /products/reviews/{reviewId} — Eliminar Product Review
- POST /products/reviews/bulk-update — Actualizar Product Reviews
- GET /products/{productId} — Obtener Product by Id
- DELETE /products/{productId} — Eliminar Product by Id
- PUT /products/{productId} — Actualizar Product by Id
- POST /products/ — Crear producto
- GET /products/ — Listar productos
POST /products/bulk-update
Bulk Update Products API to bulk update products (price, availability, collections, delete)
Scopes requeridos: products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- type (requerido) — string — Type of bulk update operation
- productIds (requerido) — array — Array of product IDs
- filters — — Filters to apply when selectAll is true
- price — — Price update configuration
- compareAtPrice — — Compare at price update configuration
- availability — boolean — New availability status
- collectionIds — array — Array of collection IDs
- currency — string — Currency code
Respuestas:
- 201 — Products updated successfully
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/bulk-update/edit
Bulk Edit Products and Prices API to bulk edit products and their associated prices (max 30 entities)
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- products (requerido) — array — Array of products to update. Note: The total count includes all prices within each product.
- _id (requerido) — string — Product Id
- name — string — Product name
- description — string — Product description
- image — string — Product image
- availableInStore — boolean — Product availability in store
- prices — array — Array of price variants for the product
- _id (requerido) — string — Price Id
- name — string — Price name
- amount — number — Price amount
- currency — string — Price currency
- compareAtPrice — number — Compare at price
- availableQuantity — number — Available quantity
- trackInventory — boolean — Track inventory
- allowOutOfStockPurchases — boolean — Allow out of stock purchases
- sku — string — SKU
- trialPeriod — number — Trial period in days
- totalCycles — number — Total billing cycles
- setupFee — number — Setup fee
- shippingOptions — — Shipping options
- recurring — — Recurring details
- collectionIds — array — Collection IDs
- isLabelEnabled — boolean — Enable product label
- isTaxesEnabled — boolean — Enable taxes
- seo — — SEO metadata for the product
- slug — string — Product URL slug
- automaticTaxCategoryId — string — Automatic tax category Id
- taxInclusive — boolean — Tax inclusive pricing
- taxes — array — Product taxes
- medias — array — Product media
- label — object — Product label
Respuestas:
- 201 — Products and prices updated successfully
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/{productId}/price
Crear Price for a Product The "Create Price for a Product" API allows adding a new price associated with a specific product to the system. Use this endpoint to create a price with the specified details for a particular product. Ensure that the required information is provided in the request payload.
Scopes requeridos: products/prices.write, products/prices.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id of the product that needs to be used
Cuerpo de la peticion (application/json):
- name (requerido) — string — The name of the price.
- type (requerido) — string — The type of the price.
- currency (requerido) — string — The currency of the price.
- amount (requerido) — number — The amount of the price. ( min: 0 )
- recurring — — The recurring details of the price (if type is recurring).
- description — string — A brief description of the price.
- membershipOffers — array — An array of membership offers associated with the price.
- label (requerido) — string — Membership offer label
- value (requerido) — string — Membership offer label
- _id (requerido) — string — The unique identifier for the membership offer.
- trialPeriod — number — The trial period duration in days (if applicable).
- totalCycles — number — The total number of billing cycles for the price. ( min: 1 )
- setupFee — number — The setup fee for the price.
- variantOptionIds — array — An array of variant option IDs associated with the price.
- compareAtPrice — number — The compare at price for the price.
- locationId (requerido) — string — The unique identifier of the location associated with the price.
- userId — string — The unique identifier of the user who created the price.
- meta — — Additional metadata associated with the price.
- trackInventory — boolean — Need to track inventory stock quantity
- availableQuantity — number — Available inventory stock quantity
- allowOutOfStockPurchases — boolean — Continue selling when out of stock
- sku — string — The unique identifier of the SKU associated with the price
- shippingOptions — — Shipping options of the Price
- isDigitalProduct — boolean — Is the product a digital product
- digitalDelivery — array — Digital delivery options
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/{productId}/price
Listar Prices for a Product The "List Prices for a Product" API allows retrieving a paginated list of prices associated with a specific product. Customize your results by filtering prices or paginate through the list using the provided query parameters.
Scopes requeridos: products/prices.readonly, products/prices.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id of the product that needs to be used
- limit (query, number) — Cantidad máxima de resultados por página
- offset (query, number) — Indice inicial de la página de resultados
- locationId (query, string) (requerido) — The unique identifier for the location.
- ids (query, string) — To filter the response only with the given price ids, Please provide with comma separated
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/inventory
Listar Inventory The "List Inventory API allows the user to retrieve a paginated list of inventory items. Use this endpoint to fetch details for multiple items in the inventory based on the provided query parameters.
Scopes requeridos: products/prices.readonly, products/prices.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- limit (query, number) — Cantidad máxima de resultados por página
- offset (query, number) — Indice inicial de la página de resultados
- altId (query, string) (requerido) — Id de la sede o de la agencia
- altType (query, string) (requerido) —
- search (query, string) — Search string for Variant Search
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/inventory
Actualizar Inventory The Update Inventory API allows the user to bulk update the inventory for multiple items. Use this endpoint to update the available quantity and out-of-stock purchase settings for multiple items in the inventory.
Scopes requeridos: products/prices.write, products/prices.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- items (requerido) — array — Array of items to update in the inventory.
- priceId (requerido) — string — The unique identifier for the price, in MongoDB Id format.
- availableQuantity — number — The available quantity of the item.
- allowOutOfStockPurchases — boolean — Whether to continue selling the item when out of stock.
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/{productId}/price/{priceId}
Obtener Price by Id for a Product The "Get Price by Id for a Product" API allows retrieving information for a specific price associated with a particular product using its unique identifier. Use this endpoint to fetch details for a single price based on the provided price Id and product Id.
Scopes requeridos: products/prices.readonly, products/prices.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id of the product that needs to be used
- priceId (path, string) (requerido) — Id of the price that needs to be returned
- locationId (query, string) (requerido) — Id de sede
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
PUT /products/{productId}/price/{priceId}
Actualizar Price by Id for a Product The "Update Price by Id for a Product" API allows modifying information for a specific price associated with a particular product using its unique identifier. Use this endpoint to update details for a single price based on the provided price Id and product Id.
Scopes requeridos: products/prices.write, products/prices.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id of the product that needs to be used
- priceId (path, string) (requerido) — Id of the price that needs to be returned
Cuerpo de la peticion (application/json):
- name (requerido) — string — The name of the price.
- type (requerido) — string — The type of the price.
- currency (requerido) — string — The currency of the price.
- amount (requerido) — number — The amount of the price. ( min: 0 )
- recurring — — The recurring details of the price (if type is recurring).
- description — string — A brief description of the price.
- membershipOffers — array — An array of membership offers associated with the price.
- label (requerido) — string — Membership offer label
- value (requerido) — string — Membership offer label
- _id (requerido) — string — The unique identifier for the membership offer.
- trialPeriod — number — The trial period duration in days (if applicable).
- totalCycles — number — The total number of billing cycles for the price. ( min: 1 )
- setupFee — number — The setup fee for the price.
- variantOptionIds — array — An array of variant option IDs associated with the price.
- compareAtPrice — number — The compare at price for the price.
- locationId (requerido) — string — The unique identifier of the location associated with the price.
- userId — string — The unique identifier of the user who created the price.
- meta — — Additional metadata associated with the price.
- trackInventory — boolean — Need to track inventory stock quantity
- availableQuantity — number — Available inventory stock quantity
- allowOutOfStockPurchases — boolean — Continue selling when out of stock
- sku — string — The unique identifier of the SKU associated with the price
- shippingOptions — — Shipping options of the Price
- isDigitalProduct — boolean — Is the product a digital product
- digitalDelivery — array — Digital delivery options
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /products/{productId}/price/{priceId}
Eliminar Price by Id for a Product The "Delete Price by Id for a Product" API allows deleting a specific price associated with a particular product using its unique identifier. Use this endpoint to remove a price from the system.
Scopes requeridos: products/prices.write, products/prices.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id of the product that needs to be used
- priceId (path, string) (requerido) — Id of the price that needs to be returned
- locationId (query, string) (requerido) — Id de sede
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/store/{storeId}/stats
Fetch Product Store Stats API to fetch the total number of products, included in the store, and excluded from the store and other stats
Scopes requeridos: products.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- storeId (path, string) (requerido) — Products related to the store
- altId (query, string) (requerido) — Id de la sede o de la agencia
- altType (query, string) (requerido) —
- search (query, string) — The name of the product for searching.
- collectionIds (query, string) — Filter by product collection Ids. Supports comma separated values
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/store/{storeId}
Action to include/exclude the product in store API to update the status of products in a particular store
Scopes requeridos: products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- storeId (path, string) (requerido) — Products related to the store
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- action (requerido) — string — Action to include or exclude the product from the store
- productIds (requerido) — array — Array of product IDs
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/store/{storeId}/priority
Actualizar product display priorities in store API to set the display priority of products in a store
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- storeId (path, string) (requerido) — Products related to the store
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- products (requerido) — array — Array of products with their display priorities
Respuestas:
- 200 — Successfully updated display priorities
- 400 — Peticion invalida
- 401 — No autorizado
GET /products/collections
Fetch Product Collections Internal API to fetch the Product Collections
Scopes requeridos: products/collection.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- limit (query, number) — Cantidad máxima de resultados por página
- offset (query, number) — Indice inicial de la página de resultados
- altId (query, string) (requerido) — Id de sede
- altType (query, string) (requerido) — The type of alt. For now it is only LOCATION
- collectionIds (query, string) — Ids of the collections separated by comma(,) for search purposes
- name (query, string) — Query to search collection based on names
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/collections
Crear Product Collection Create a new Product Collection for a specific location
Scopes requeridos: products/collection.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id
- altType (requerido) — string — The type of alt. For now it is only LOCATION
- collectionId — string — Unique Identifier of the Product Collection, Mongo Id
- name (requerido) — string — Name of the Product Collection
- slug (requerido) — string — Slug of the Product Collection which helps in navigation
- image — string — The URL of the image that is going to be displayed as the collection Thumbnail
- seo — — The metadata information which will be displayed in SEO previews
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/collections/{collectionId}
Obtener Details about individual product collection Scopes requeridos: products/collection.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- collectionId (path, string) (requerido) — Id de Collection
- altId (query, string) (requerido) — Id de sede
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
PUT /products/collections/{collectionId}
Actualizar Product Collection Update a specific product collection with Id :collectionId
Scopes requeridos: products/collection.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- collectionId (path, string) (requerido) — MongoId of the collection
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id
- altType (requerido) — string — The type of alt. For now it is only LOCATION
- name — string — Name of the Product Collection
- slug — string — Slug of the Product Collection which helps in navigation
- image — string — The URL of the image that is going to be displayed as the collection Thumbnail
- seo — — The metadata information which will be displayed in SEO previews
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /products/collections/{collectionId}
Eliminar Product Collection Delete specific product collection with Id :collectionId
Scopes requeridos: products/collection.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- collectionId (path, string) (requerido) — MongoId of the collection
- altId (query, string) (requerido) — Id de sede
- altType (query, string) (requerido) — The type of alt. For now it is only LOCATION
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/reviews
Fetch Product Reviews API to fetch the Product Reviews
Scopes requeridos: products.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- altId (query, string) (requerido) — Id de la sede o de la agencia
- altType (query, string) (requerido) —
- limit (query, number) — Cantidad máxima de resultados por página
- offset (query, number) — Indice inicial de la página de resultados
- sortField (query, string) — The field upon which the sort should be applied
- sortOrder (query, string) — The order of sort which should be applied for the sortField
- rating (query, number) — Key to filter the ratings
- startDate (query, string) — The start date for filtering reviews
- endDate (query, string) — The end date for filtering reviews
- productId (query, string) — Comma-separated list of product IDs
- storeId (query, string) — Comma-separated list of store IDs
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/reviews/count
Fetch Review Count as per status API to fetch the Review Count as per status
Scopes requeridos: products.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- altId (query, string) (requerido) — Id de la sede o de la agencia
- altType (query, string) (requerido) —
- rating (query, number) — Key to filter the ratings
- startDate (query, string) — The start date for filtering reviews
- endDate (query, string) — The end date for filtering reviews
- productId (query, string) — Comma-separated list of product IDs
- storeId (query, string) — Comma-separated list of store IDs
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
PUT /products/reviews/{reviewId}
Actualizar Product Reviews Update status, reply, etc of a particular review
Scopes requeridos: products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- reviewId (path, string) (requerido) — Id de Review
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- productId (requerido) — string — Product Id
- status (requerido) — string — Status of the review
- reply — array — Reply of the review
- headline (requerido) — string — Headline of the Review
- comment (requerido) — string — Detailed Review of the product
- user (requerido) — — User who is giving the review/reply
- rating — number — Rating of the product
- headline — string — Headline of the Review
- detail — string — Detailed Review of the product
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /products/reviews/{reviewId}
Eliminar Product Review Delete specific product review
Scopes requeridos: products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- reviewId (path, string) (requerido) — Id de Review
- altId (query, string) (requerido) — Id de la sede o de la agencia
- altType (query, string) (requerido) —
- productId (query, string) (requerido) — Product Id of the product
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/reviews/bulk-update
Actualizar Product Reviews Update one or multiple product reviews: status, reply, etc.
Scopes requeridos: products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- altId (requerido) — string — Location Id or Agency Id
- altType (requerido) — string
- reviews (requerido) — array — Array of Product Reviews
- reviewId (requerido) — string — Review Id
- productId (requerido) — string — Product Id
- storeId (requerido) — string — Store Id
- status (requerido) — object — Status of the review
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/{productId}
Obtener Product by Id The "Get Product by Id" API allows to retrieve information for a specific product using its unique identifier. Use this endpoint to fetch details for a single product based on the provided product Id.
Scopes requeridos: products.readonly, products.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id or the slug of the product that needs to be returned
- locationId (query, string) (requerido) — Id de sede
- sendWishlistStatus (query, boolean) — Parameter which will decide whether to show the wishlisting status of products
Respuestas:
- 200 — Respuesta exitosa
- 400 — Product not found
- 401 — No autorizado
- 422 — Entidad no procesable
DELETE /products/{productId}
Eliminar Product by Id The "Delete Product by Id" API allows deleting a specific product using its unique identifier. Use this endpoint to remove a product from the system.
Scopes requeridos: products.write, products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id or the slug of the product that needs to be returned
- locationId (query, string) (requerido) — Id de sede
- sendWishlistStatus (query, boolean) — Parameter which will decide whether to show the wishlisting status of products
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
PUT /products/{productId}
Actualizar Product by Id The "Update Product by Id" API allows modifying information for a specific product using its unique identifier. Use this endpoint to update details for a single product based on the provided product Id.
Scopes requeridos: products.write, products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- productId (path, string) (requerido) — Id or the slug of the product that needs to be returned
Cuerpo de la peticion (application/json):
- name (requerido) — string — The name of the product.
- locationId (requerido) — string — The unique identifier for the location.
- description — string — A brief description of the product.
- productType (requerido) — string
- image — string — The URL for the product image.
- statementDescriptor — string — The statement descriptor for the product.
- availableInStore — boolean — Indicates whether the product is available in-store.
- medias — array — An array of medias for the product.
- id (requerido) — string — The unique identifier for the media.
- title — string — The title of the media file.
- url (requerido) — string — The URL where the media file is stored.
- type (requerido) — string — The type of the media file (e.g., image, video will be supporting soon).
- isFeatured — boolean — Indicates whether the media is featured.
- priceIds — array — Mongo ObjectIds of the prices for which the media is assigned
- variants — array — An array of variants for the product.
- id (requerido) — string — A unique identifier for the variant.
- name (requerido) — string — The name of the variant.
- options (requerido) — array — An array of options for the variant.
- id (requerido) — string — The unique identifier for the option.
- name (requerido) — string — The name of the option.
- collectionIds — array — An array of category Ids for the product
- isTaxesEnabled — boolean — Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
- taxes — array — List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
- automaticTaxCategoryId — string — Tax category Id for Automatic taxes calculation.
- isLabelEnabled — boolean — Is the product label enabled. If this is true, label object cannot be empty.
- label — — Details for Product Label
- slug — string — The slug using which the product navigation will be handled
- seo — — SEO data for the product that will be displayed in the preview
- taxInclusive — boolean — Whether the taxes should be included in the purchase price
- prices — array — The prices of the product
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
POST /products/
Crear producto The "Create Product" API allows adding a new product to the system. Use this endpoint to create a product with the specified details. Ensure that the required information is provided in the request payload.
Scopes requeridos: products.write, products.write
Parametros:
- Versión (header, string) (requerido) — Versión de la API
Cuerpo de la peticion (application/json):
- name (requerido) — string — The name of the product.
- locationId (requerido) — string — The unique identifier for the location.
- description — string — A brief description of the product.
- productType (requerido) — string
- image — string — The URL for the product image.
- statementDescriptor — string — The statement descriptor for the product.
- availableInStore — boolean — Indicates whether the product is available in-store.
- medias — array — An array of medias for the product.
- id (requerido) — string — The unique identifier for the media.
- title — string — The title of the media file.
- url (requerido) — string — The URL where the media file is stored.
- type (requerido) — string — The type of the media file (e.g., image, video will be supporting soon).
- isFeatured — boolean — Indicates whether the media is featured.
- priceIds — array — Mongo ObjectIds of the prices for which the media is assigned
- variants — array — An array of variants for the product.
- id (requerido) — string — A unique identifier for the variant.
- name (requerido) — string — The name of the variant.
- options (requerido) — array — An array of options for the variant.
- id (requerido) — string — The unique identifier for the option.
- name (requerido) — string — The name of the option.
- collectionIds — array — An array of category Ids for the product
- isTaxesEnabled — boolean — Are there any taxes attached to the product. If this is true, taxes array cannot be empty.
- taxes — array — List of ids of Taxes attached to the Product. If taxes are passed, isTaxesEnabled should be true.
- automaticTaxCategoryId — string — Tax category Id for Automatic taxes calculation.
- isLabelEnabled — boolean — Is the product label enabled. If this is true, label object cannot be empty.
- label — — Details for Product Label
- slug — string — The slug using which the product navigation will be handled
- seo — — SEO data for the product that will be displayed in the preview
- taxInclusive — boolean — Whether the taxes should be included in the purchase price
Respuestas:
- 201 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
GET /products/
Listar productos The "List Products" API allows to retrieve a paginated list of products. Customize your results by filtering products based on name or paginate through the list using the provided query parameters. This endpoint provides a straightforward way to explore and retrieve product information.
Scopes requeridos: products.readonly, products.readonly
Parametros:
- Versión (header, string) (requerido) — Versión de la API
- limit (query, number) — Cantidad máxima de resultados por página
- offset (query, number) — Indice inicial de la página de resultados
- locationId (query, string) (requerido) — LocationId is the id of the sub-account
- search (query, string) — The name of the product for searching.
- collectionIds (query, string) — Filter by product category Ids. Supports comma separated values
- collectionSlug (query, string) — The slug value of the collection by which the collection would be searched
- expand (query, array) — Name of an entity whose data has to be fetched along with product. Possible entities are tax, stripe and paypal. If not mentioned, only Id will be returned in case of taxes
- productIds (query, array) — List of product ids to be fetched.
- storeId (query, string) — fetch and project products based on the storeId
- includedInStore (query, boolean) — Separate products by which are included in the store and which are not
- availableInStore (query, boolean) — If the product is included in the online store
- sortOrder (query, string) — The order of sort which should be applied for the date
Respuestas:
- 200 — Respuesta exitosa
- 400 — Peticion invalida
- 401 — No autorizado
- 422 — Entidad no procesable
