Skip to main content

Product

team
REQUIRED

Type: string (format: iri-reference)

The team reference to which the product belongs.

Example: /shipments/83829499-f99c-4c91-9908-76c91f2ae312

name

Type: string|null

The name of product.

Example: Jacket

sku

Type: string|null

The SKU of product.

Example: JACKET-01

originUrl

Type: string|null (format: URL)

The URL of product in the ecommerce store.

Example: http://my-store/products/jacket

imageUrl

Type: string|null (format: URL)

The URL of product image in the ecommerce store.

Example: http://my-store/media/products/jacket.jpg

externalSourceIntegration

Type: string|null (format: iri-reference)

The workflow reference to integration for ecommerce store.

Example: /workflows/a0b97939-5aea-4b35-b7c6-64f56bff1721

externalSourceSyncId

Type: string|null

The id of the shipment in ecommerce store (WooCommerce, Shopify, etc.).

Example: wp_00001

productVariants

Type: array

List of product variant references that belong to the product.

Example: ['/product_variants/cbe5589f-8869-4a9c-9d9c-3d7f70d66878', '/product_variants/3eb2f084-ea29-41ed-9bfb-691381bd7511']

id
READ-ONLY

Type: string (format: uuid)

A unique version 4 UUID.

Example: 625c21dc-1e78-4b5c-8e29-5a1d7f84f4ac