Brand catalog: models of your own brands

Who it is for

An organization that is a confirmed brand owner: the ownership application is filed on the "Brands" tab of the organization. The organization keeps models of its brands for free, and its values outrank the import of open sources. The key needs the "Manage brand models" permission, the caller needs the right to manage the organization listings.

A batch

Models are submitted as a batch to POST /rest/v1/catalog/seller/model-nodes/sync with an Idempotency-Key header — a repeat and a busy key behave as in catalog synchronization. Batch fields: organizationId — the owning organization, defaultCategoryId — the category of rows without their own, publish — publish models after writing, items — the rows.

{
  "organizationId": "0192f0c0-0000-7000-8000-00000000000a",
  "defaultCategoryId": "0192f0c0-0000-7000-8000-000000000001",
  "publish": true,
  "items": [
    {
      "brand": "Atlas",
      "name": "GA 30",
      "barcode": "4006381333931",
      "manufacturerCode": "GA30-VSD",
      "attributes": { "Power": "30", "Drive": "direct, belt" },
      "imageUrls": ["https://example.org/img/ga30.jpg"]
    }
  ]
}

A row

brand — the brand by its label or key; an organization with a single brand may omit it. name — the model name, a leading brand name is stripped. categoryId or categorySlug — the category by identifier or by the address segment of its page. attributes — category attributes by label or key with the value as text, several values separated by commas; an attribute outside the category is skipped. imageUrls — photos, the platform fetches them itself and gives the model exactly the submitted set.

Matching

A row finds the model by barcode, then by manufacturer code within the brand, then by model name within the brand and category; otherwise it creates the model as a draft. Rows of one batch about the same model do not duplicate it. Values corrected by a platform editor are not overwritten by a row.

Publication

With the publish flag a model is published right after writing. An attribute the model has no value for is filled in by the seller in their listing.

The response

Rows in the order of the request: modelNodeId, the created flag and, on refusal, error and errorDetails; totals — accepted, created, updated, failed. A refused row does not cancel the others. Refusal reasons: BRAND_NOT_OWNED — the brand does not belong to the organization, ATTRIBUTE_INVALID_TYPE — the value does not fit the attribute, MODEL_CODE_TAKEN — the code belongs to another model, MODEL_CODE_INVALID — the barcode is not a GTIN. A batch over the row limit or the per-row photo limit is rejected whole with SELLER_SYNC_BATCH_TOO_LARGE or SELLER_SYNC_IMAGES_TOO_MANY, the limit is named in the operation reference and in the error details.

Was this article helpful?

Did not find the answer to your question?

Create a request