Product Import API Specification

Type: object

path: #

$schema: http://json-schema.org/draft-07/schema#

This schema does not accept additional properties.

Properties

• in
  • Type: object
  • path: #/properties/in
  • This schema does not accept additional properties.
  • Properties
    • • update_code required
        • • Only INSERT_AND_UPDATE and INSERT are currently supported.
          • Type: string
          • path: #/properties/in/properties/update_code
          • The value is restricted to the following:
            1. "INSERT_AND_UPDATE"
            2. "INSERT"
          • Length:  ≤ 17
      • sales_channel_reference required
        • • Type: string
          • path: #/properties/in/properties/sales_channel_reference
      • weight
        • • In gram if weight_unity is zero.
          • Type: integer
          • path: #/properties/in/properties/weight
      • weight_unit
        • • Determines the exponent of weight.
          • Type: integer
          • path: #/properties/in/properties/weight_unit
      • product_reference required
        • • Identifier of the product in the external system.
          • Type: string
          • path: #/properties/in/properties/product_reference
          • Length:  ≤ 50
      • product_description_1 required
        • • Description of the product.
          • Type: string
          • path: #/properties/in/properties/product_description_1
          • Length:  ≤ 250
      • product_description_2
        • • A secondary description of the product.
          • Type: string
          • path: #/properties/in/properties/product_description_2
          • Length:  ≤ 250
      • default_packaging
        • • path: #/properties/in/properties/default_packaging
          • $ref: #/$defs/packaging
      • smallest_packaging
        • • path: #/properties/in/properties/smallest_packaging
          • $ref: #/$defs/packaging
      • full_packaging
        • • path: #/properties/in/properties/full_packaging
          • $ref: #/$defs/packaging
      • supplier_conditions
        • • Type: array
          • path: #/properties/in/properties/supplier_conditions
            • • Items
              • path: #/properties/in/properties/supplier_conditions/items
              • $ref: #/$defs/supplierCondition
      • product_ids
        • • The product ids array represent the product identifications which can be a EAN barcode number or a product reference.
          • Type: array
          • path: #/properties/in/properties/product_ids
            • • Items
              • Type: object
              • path: #/properties/in/properties/product_ids/items
              • This schema does not accept additional properties.
              • Properties
                • • id
                  • Type: string
                  • path: #/properties/in/properties/product_ids/items/properties/id
              •  type
                • • The type can either be EAN or REF. An EAN type requires the id field to contain a valid EAN barcode, invalid EAN barcodes will cause the type to change to REF.
                  • Type: string
                  • path: #/properties/in/properties/product_ids/items/properties/type
                  • The value is restricted to the following:
                    1. "EAN"
                    2. "REF"
              • supplier_address
              • path: #/properties/in/properties/supplier_address
              • $ref: #/$defs/address
          • properties
            • • Type: array
              • path: #/properties/in/properties/properties
                • • Items
                  • Type: object
                  • path: #/properties/in/properties/properties/items
                  • This schema accepts additional properties.
                  • Properties
                    • name
                      • • Type: string
                        • path: #/properties/in/properties/properties/items/properties/name
                    • value
                      • • Types: string, null
                        • path: #/properties/in/properties/properties/items/properties/value
          • accounting_price
            • • Type: number
              • path: #/properties/in/properties/accounting_price
              • Range:  ≥ 0
          • product_group_reference
            • • the product group reference for the product, leaving the product group empty causes the product to belong to the last child of the 'Assortiment' group
              • Type: string
              • path: #/properties/in/properties/product_group_reference
              • Length:  ≥ 1