Catalogs data entity includes information about your products in an SKU level.
All catalog information must be included on every upload.
Adding optional fields will let you enhance the experience beyond what's required by the mandatory fields to a whole new level of user experience.
Here is a list of the fields we can include in our integration, followed by the attached files:
- An example file
- A mapping file
Mandatory Fields
| Field Name | Properties |
|---|---|
| cost |
Type: Float Requirements: Positive float Description: Cost of product |
| id |
Type: String Requirements: Length > 1 Description: SKU identifier from client's system |
| name |
Type: String Requirements: Length > 1 Description: Name of the SKU |
| price |
Type: Float Requirements: Positive float Description: Catalog price |
| product_id |
Type: String Requirements: Length > 1 Description: Can also be addressed as reference, some will use only Style Color or Style; If the product is non-sizable, sku_id=product_id - map the same ID for both. |
| product_name |
Type: String Requirements: Length > 1 Description: The name of the product |
| size |
Type: String Default: - Description: Sizes that are available for this SKU; If multiple values separate them by #; The new values are accumulated and are not overridden; This is optional field in case your products don't have sizes |
Optional fields
| Field Name | Properties |
|---|---|
| discount_price |
Type: Float Default: - Description: Selling price after discount |
| avoid_replenishment |
Type: Boolean Default: False Description: Replenish or not replenish the SKU; False = Replenish; Mandatory to have this field in at least one input file to enhance functionalities |
| brands |
Type: String Default: - Description: The brand the SKU belongs to; If multiple values separate them by #; The new values are accumulated and are not overridden; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| categories |
Type: String Default: - Description: The category the SKU belongs to; If multiple values separate them by #; The new values are accumulated and are not overridden; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| colors |
Type: String Default: - Description: Color of the SKU; If multiple values separate them by #; The new values are accumulated and are not overridden; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| cost_currency |
Type: String Default: - taken from account default currency_id Description: Currency of the product's cost; currently support only 1 currency for account |
| custom_* |
Type: Any Default: - Description: Custom fields can be added to the input file according to your requirements. The fields' names must begin with "custom_" and their types should be provided to your TAM. |
| department_id |
Type: String Default: - Description: SKU department identifier; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| department_name |
Type: String Default: - Description: SKU department name; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| description |
Type: String Default: - Description: Free text describing the SKU |
| end_of_life_date |
Type: Timestamp (ISO8601) Default: - Description: The date in which this SKU reached the end of its lifecycle |
| markets |
Type: String Default: - Description: Target market; "If multiple values separate them by #; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| introduction_date |
Type: Timestamp (ISO8601) Default: - Description: The date in which this SKU was first introduced for sale |
| pack_constraint |
Type: Integer Requierment: Positive integer Default: 1 Description: Referring to a case where an SKU is shipped as a batch and sold separately in stores; for example accessories packed with 1 unit |
| pictures |
Type: String Default: - Description: Photo of the SKU (a URL of the image uploaded to a public address on the internet); If multiple values separate them by #; Recommended to enhance the visual experience in the account; Allowed image formats: PNG, GIF, JPEG, WebP, SVG - Maximum image dimension is 12,000 pixels. - Maximum image area is limited to 100 megapixels (for example, 10,000×10,000 pixels). - Image metadata is limited to 1024 bytes. - Images have a 10 megabyte (MB) size limit. - Animated GIFs/WebP, including all frames, are limited to 50 megapixels (MP). |
| price_currency |
Type: String Default: taken from account default currency_id Description: Currency of the product's price; currently support only 1 currency for account |
| product_description |
Type: String Default: - Description: Free text describing the product |
| product_type |
Type: String Default: - Description: Merchandise type, such as: fashion, fast fashion, core, basic, etc |
| seasons |
Type: String Default: - Description: Seasons for which the SKU is relevant; If multiple values separate them by #; The new values are accumulated and are not overridden; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| styles |
Type: String Default: - Description: Style of the SKU; If multiple values separate them by #; The new values are accumulated and are not overridden; The addition of this attribute is recommended as it can be used to enhance the analytics dashboards |
| wh_pack_constraint |
Type: Integer Requierment: Positive integer Default: 1 Description: Referring to a case where an SKU is shipped as a batch from the warehouse to the warehouse |
| fabric |
Type: String Default: - Description: The main material or textile the item is made of (e.g., cotton, polyester) |
| length |
Type: String Default: - Description: The total length of the item, typically measured from the top to the bottom edge (e.g. 32 inches, or long pants, midi dress) |
| sleeve_length |
Type: String Default: - Description: The measurement from the shoulder seam to the end of the sleeve (e.g. short sleeve, long sleeve) |
| actual_price |
Type: Float Requirements: Positive float Description: The price the item was actually sold for |
| status |
Type: Boolean Default: True Description: Is the product active or inactive |
Comments
0 comments
Article is closed for comments.