Goods

Update item/category by external id (beta)

Update item/category by external identifier.

Key points

  • The type of the object being edited is specified in the data.type field. Three values are supported:
    • CATEGORY — for a category
    • ITEM — for a product item
    • VARYING_ITEM — for a product with variants
  • To move an item to a different category, specify the target category ID in nodeId.
  • To remove an item from its category (make it top-level), set nodeId to null.

Errors

StatusError CodeDescription
400goods.nodeIndex.invalidSpecifying a nodeId is not allowed when updating a category.
404notFoundItem/category with the given external identifier was not found.
put/goods/external/{externalId}

Request body

idinteger

Goods ID.

namestring required

Goods name.

nodeIdinteger nullable

ID of the category in which the item is included.

externalIdstring nullable

External goods identifier.

dateCreatedstring date-time

Date item created.

hiddenboolean nullable

Is the goods hidden.

blockedboolean nullable

Is the goods blocked.

imageUrlsstring[]

Array of imageId from presigned url response

Response

OK

idinteger

Goods ID.

namestring required

Goods name.

nodeIdinteger nullable

ID of the category in which the item is included.

externalIdstring nullable

External goods identifier.

dateCreatedstring date-time

Date item created.

hiddenboolean nullable

Is the goods hidden.

blockedboolean nullable

Is the goods blocked.

imageUrlsstring[]

Array of imageId from presigned url response

Changes

No recorded changes to this endpoint across all 1 revision of this API.