Skip to main content
API docs by Redocly

Product Management Service (2026-07-31.2721898287)

Download OpenAPI specification:Download

API for managing merchant product catalog data.

Get Product Statistics

Provides statistics about product master data in the Logitrail's database.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "product_statistics": {
    }
}

List Products

Returns a paginated list of merchant products. Filters AND-merge; q provides unified search across SKU prefix, GTIN prefix, vendor SKU prefix, vendor barcode prefix and (for length ≥ 3) product name substring.

Authorizations:
idp
query Parameters
q
string >= 2 characters

Unified search phrase (minimum 2 characters). Matches case-insensitive anchored prefix on SKU, GTIN, vendor SKU and vendor barcode; for length ≥ 3 also matches a case-insensitive substring on the product name (incl. translations). At lengths 2–3 the name is intentionally excluded — unanchored regex on n would explode the candidate set.

sku
string non-empty

Exact match on the merchant SKU (m_id).

gtin
string non-empty

Exact match on GTIN — matches either the primary gtin or the secondary s_gtin.

status
string
Enum: "active" "deleted"

Filter by status. Defaults to active so deleted products are hidden by default; pass deleted explicitly to retrieve them.

on_shelf_minimum_count
integer [ 0 .. 9007199254740991 ]

Restrict results to products whose on-shelf (inventory.in_stock) count is at least the given value. Cross-service post-filter — the page is shrunk after the inventory join, so the returned page may be smaller than limit.

offset
integer [ 0 .. 9007199254740991 ]
Default: 0

Pagination offset. Defaults to 0.

limit
integer [ 1 .. 500 ]
Default: 100

Maximum number of products to return. Defaults to 100, capped at 500.

header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "products": [
    ]
}

Create Product

Creates a new product.

Authorizations:
idp
header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json
required
object
sku
required
string

Merchant's own SKU. The SKU must be unique within the merchant and active products.

gtin
string

GTIN (EAN / Barcode) of the product. This value is used to identify the product at the warehouse.

name
required
string

Name of the product in merchant's primary language. If you need translations, provide them in name_translations field.

object

Name of the product in different languages.

status
string
Default: "active"
Enum: "active" "deleted"
string or null
string or null

HS code (Harmonized System code) of the product.

fulfillment_by
string (Fulfillment route)
Default: "logitrail"
Enum: "logitrail" "merchant"

Default fulfillment route for this product. logitrail means Logitrail's warehouse picks and ships order lines for the product; merchant means the merchant fulfills the line themselves and Logitrail does not pick or ship it. Individual order lines may override this per line; when an order line omits the value, it falls back to this product-level default. Products that pre-date this field default to logitrail.

string or null

Country code (ISO 3166-1 alpha-2) of the product's origin.

number or null
flags
Array of strings
weight_g
number >= 1
Array of numbers or null

Dimensions (in mm) of the product. Three dimensions are required. If dimensions are not known, use null or [0,0,0].

Array of objects or null

Product component definition.

Array of objects

Batch package types of the product.

Array of objects <= 20 items

Supplier-side identifiers for this product. Empty array means no supplier codes are recorded; omit to leave the existing array untouched (on writes) or to inherit from the product profile (on inbound-shipment line items).

object or null

Current inventory snapshot for this product, owned by product-inventory-service. Null when no ProductInventoryDocument exists for the product yet (e.g. brand new product without any incoming articles). Omitted from the response when the listing was retrieved without joining inventory data.

object (Tracking requirements)

Per-unit tracking requirements enforced during warehouse handling for this product.

Dangerous goods declaration (object) or Dangerous goods declaration (null) (Dangerous goods declaration)

ADR/VAK dangerous-goods classification of the product. Omitted for products that are not classified as dangerous goods. When supplied, every field of the declaration is required. Send null to remove an existing declaration.

Not-dangerous-goods declaration (object) or Not-dangerous-goods declaration (null) (Not-dangerous-goods declaration)

Declare that this product is not dangerous goods, or update the reason on an existing declaration. Send null to withdraw an existing declaration. Omit to leave any existing declaration untouched. The declaration timestamp and declaring identity are recorded automatically and cannot be set by the caller.

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

Get Product

Returns the product information.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$

Logitrail's internal technical ID of the product.

header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "product": {
    }
}

Update Product

Updates an existing product.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$

Logitrail's internal technical ID of the product.

header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json
required
object
sku
string

Merchant's own SKU. The SKU must be unique within the merchant and active products.

gtin
string

GTIN (EAN / Barcode) of the product. This value is used to identify the product at the warehouse.

name
string

Name of the product in merchant's primary language. If you need translations, provide them in name_translations field.

object

Name of the product in different languages.

status
string
Default: "active"
Enum: "active" "deleted"
string or null
string or null

HS code (Harmonized System code) of the product.

fulfillment_by
string (Fulfillment route)
Default: "logitrail"
Enum: "logitrail" "merchant"

Default fulfillment route for this product. logitrail means Logitrail's warehouse picks and ships order lines for the product; merchant means the merchant fulfills the line themselves and Logitrail does not pick or ship it. Individual order lines may override this per line; when an order line omits the value, it falls back to this product-level default. Products that pre-date this field default to logitrail.

string or null

Country code (ISO 3166-1 alpha-2) of the product's origin.

number or null
flags
Array of strings
weight_g
number >= 1
Array of numbers or null

Dimensions (in mm) of the product. Three dimensions are required. If dimensions are not known, use null or [0,0,0].

Array of objects or null

Product component definition.

Array of objects

Batch package types of the product.

Array of objects <= 20 items

Supplier-side identifiers for this product. Empty array means no supplier codes are recorded; omit to leave the existing array untouched (on writes) or to inherit from the product profile (on inbound-shipment line items).

object or null

Current inventory snapshot for this product, owned by product-inventory-service. Null when no ProductInventoryDocument exists for the product yet (e.g. brand new product without any incoming articles). Omitted from the response when the listing was retrieved without joining inventory data.

object (Tracking requirements)

Per-unit tracking requirements enforced during warehouse handling for this product.

Dangerous goods declaration (object) or Dangerous goods declaration (null) (Dangerous goods declaration)

ADR/VAK dangerous-goods classification of the product. Omitted for products that are not classified as dangerous goods. When supplied, every field of the declaration is required. Send null to remove an existing declaration.

Not-dangerous-goods declaration (object) or Not-dangerous-goods declaration (null) (Not-dangerous-goods declaration)

Declare that this product is not dangerous goods, or update the reason on an existing declaration. Send null to withdraw an existing declaration. Omit to leave any existing declaration untouched. The declaration timestamp and declaring identity are recorded automatically and cannot be set by the caller.

Responses

Request samples

Content type
application/json
{
  • "product": {
    }
}

Response samples

Content type
application/json
{
  • "product": {
    }
}

Add Product Attachment

Links an already-uploaded attachment to the product with a purpose and optional remarks. Returns the updated attachment list.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$

Logitrail's internal technical ID of the product.

header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Request Body schema: application/json
attachment_id
required
string^[a-f0-9]{24}$

Internal Attachment ID (24-hex MongoDB ObjectId).

purpose
required
string
Enum: "product_label" "product_image" "other"

Purpose of the attachment. Closed enum — one of product_label, product_image, other.

remarks
string <= 2000 characters

Optional freeform comment stored alongside the link.

Responses

Request samples

Content type
application/json
{
  • "attachment_id": "5f9b1b9b9b9b9b9b9b9b9b9b",
  • "purpose": "product_label",
  • "remarks": "Label template v2, approved 2025-01"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}

List Product Attachments

Returns the attachment list for a product, including short-lived download links.

Authorizations:
idp
path Parameters
productId
required
string^[a-f0-9]{24}$

Logitrail's internal technical ID of the product.

header Parameters
x-logitrail-merchant-id
required
string non-empty

Logitrail's Merchant ID.

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ]
}