Price and conditions

Using SupplierXM, a data source (typically a supplier) can share attributes describing prices and conditions of the product of its catalog. A dedicated attribute can be an attribute that only exists for this specific recipient or an attribute whose value is dedicated to the recipient (e. g. supplier contract number, net price).

As those specific attributes reflect specific conditions/content negotiated between the source and the recipient, when received, they can be accepted or rejected.

In our data model, those specific attributes are grouped in the sharingUnits element. For more information about the Sharing Units, you can refer to the Article describing the sharing units here.

Specific attributes relating to Price and condition

In addition, to the attributes that can compose a sharing unit (such as the logisticalHierarchies) described in the Sharing unit documentation article, price and conditions are described by the following main elements

ElementsDefintion
templateIdentifies a template to which are attached one or several products. Usually, those products share common attributes such as an orderStartDate or a price structure.

A template is described by a "name" and can be uniquely identified by a "uuid"
tariffNumberIdentities a specific reference expected by the retailer to reconciliate a tariff in its internal tools.
incotermCodeIdentifies the transport conditions (incoterm) applying to this price offer
orderStartDateDate from when the price applies
orderEndDateDate until when the price applies
contractNumberIdentifies the contract number to which the product is negotiated.
targetCountryListIdentifies the countries in which the product is orderable.
priceWaterfallsDescribes the price structure of the product.
bracketUnitDefines the orderable unit that applies to every bracket of the price warterfall (e.g. Box)
bracketsIdentifies all the bracket that applies to the price structure.
levelsIdentifies the values applicable for each bracket.
(e.g. Gross Price)

Examples of a sharing unit for Prices and conditions

In the following example, a tariff has been linked to a simple product without any hierarchy attached:

{
    "data": [{
        "createdAt": "2019-05-17T09:11:30",
        "gtin": "03907711316000",
        "isConsumerUnit": true,
        "lifeCycle": 0,
        "supplierId": "21421525141Fdfrsdfsdf",

        "namePublicLong": [{
            "data": "Mon produit",
            "expressedIn": {
                "code": "fra-FR"
            }
        }],
        "sharingUnits": [{
            "createdAt": "2019-05-15T12:38:15",
            "data": {
                "orderEndDate": "2019-05-30",
                "orderStartDate": "2019-05-09",
                "priceWaterfallBasisQuantityNumber": [{
                    "data": 5,
                    "expressedIn": {
                        "code": "BX",
                        "label": "box"
                    }
                }],
                "incotermCode": {
                    "code": "FCA"
                },
                "targetCountryList": [{
                    "targetCountryCode": {
                        "code": "10290"
                    }
                }],
                "contractNumber": "234234dgsdfgdfg",
                "tariffNumber": "234234dgsdfgdfg",
                "contractYear": 2019,
                "currency": {
                    "code": "EUR"
                },
                "priceWaterfalls": [{
                    "bracketUnit": null,
                    "brackets": [{
                        "min": 1
                    }],
                    "levels": [{
                        "items": [{
                            "description": "Gross price",
                            "type": {
                                "code": "grossPrice",
                                "key": "grossPrice",
                                "label": "Gross price"
                            },
                            "uuid": "be441c6c-476b-4c38-8d58-fbbdae3f207f",
                            "values": [{
                                "uuid": "ff745743-7119-4caa-8086-7a4116c42f8b",
                                "value": "123"
                            }]
                        }],
                        "type": {
                            "code": "price",
                            "data": {},
                            "description": "Price level type",
                            "label": "HT Tariff"
                        },
                        "uuid": "f143db27-a8b7-4657-a1fd-f319844da522"
                    }],
                    "product": {
                        "gtin": "03907711316000"
                    }
                }]
            },
            "product": {
                "gtin": "03907711316000"
            },
            "sourceOrganization": {
                "nameLegal": "Industriel"
            },
            "status": "AGREED",
            "targetOrganization": {
                "nameLegal": "Retailer"
            },
            "template": {
                "name": "Catalogue 2019",
                "status": "PUBLISHED",
                "uuid": "bce4f219-c40c-403a-af68-e867bc7388d7"
            },
            "updatedAt": "2019-05-17T09:12:21"
        }],
        "typePackaging": {
            "code": "EACH"
        },
        "updatedAt": "2019-05-17T09:12:29"
    }],
    "offset": 0,
    "totalResults": 1
}

In the following example a tariff has been linked to a specific logistical hierarchy:

{
  "data": [{
    "createdAt": "2019-05-17T09:11:30",
    "gtin": "03907711316000",
    "isConsumerUnit": true,
    "lifeCycle": 0,
    "logisticalHierarchies": [{
      "children": [{
        "children": [],
        "gtin": "03907711316000",
        "quantity": 10,
        "version": {
          "createdAt": "2019-05-17T09:11:30",
          "gtin": "03907711316000",
          "isConsumerUnit": true,
          "lifeCycle": 0,
          "namePublicLong": [{
            "data": "Mon produit",
            "expressedIn": {
              "code": "fra-FR"
            }
          }],
          "quantityOfConsumerUnitsContainedNumber": 1,
          "typePackaging": {
            "code": "EACH"
          },
          "updatedAt": "2019-05-17T09:12:22"
        }
      }],
      "gtin": "13907711316007",
      "version": {
        "createdAt": "2019-05-17T09:11:30",
        "gtin": "13907711316007",
        "isConsumerUnit": false,
        "lifeCycle": 0,
        "namePublicLong": [{
          "data": "pallet - Mon produit",
          "expressedIn": {
            "code": "fra-FR"
          }
        }],
        "quantityOfConsumerUnitsContainedNumber": 10,
        "typePackaging": {
          "code": "PALLET"
        },
        "updatedAt": "2019-05-17T09:11:30"
      }
    }],
    "namePublicLong": [{
      "data": "Mon produit",
      "expressedIn": {
        "code": "fra-FR"
      }
    }],
    "sharingUnits": [{
      "createdAt": "2019-05-15T12:38:15",
      "data": {
        "hierarchyProduct": {
          "gtin": "13907711316007",
          "label": "13907711316007 - pallet - Mon produit",
          "version": {
            "namePublicLong": [{
              "data": "pallet - Mon produit",
              "expressedIn": {
                "code": "fra-FR"
              }
            }]
          }
        },
        "orderEndDate": "2019-05-30",
        "orderStartDate": "2019-05-09",
        "priceWaterfallBasisQuantityNumber": [{
          "data": 5,
          "expressedIn": {
            "code": "BX",
            "label": "box"
          }
        }],
        "incotermCode": {
          "code": "FCA"
        },
        "contractNumber": "234234dgsdfgdfg",
        "tariffNumber": "234234dgsdfgdfg",
        "contractYear": 2019,
        "targetCountryList": [
                    {
                     "targetCountryCode": {
                            "code": "10290",
                        }
                    }
                ],
        "currency": {
          "code": "EUR"
        },
        "priceWaterfalls": [{
          "bracketUnit": null,
          "brackets": [{
            "min": 1
          }],
          "levels": [{
            "items": [{
              "description": "Gross price",
              "type": {
                "code": "grossPrice",
                "key": "grossPrice",
                "label": "Gross price"
              },
              "unit": {
                "code": "$",
                "label": "Amount"
              },
              "uuid": "be441c6c-476b-4c38-8d58-fbbdae3f207f",
              "values": [{
                "uuid": "ff745743-7119-4caa-8086-7a4116c42f8b",
                "value": "123"
              }]
            }],
            "type": {
              "code": "price",
              "data": {},
              "description": "Price level type",
              "label": "HT Tariff"
            },
            "uuid": "f143db27-a8b7-4657-a1fd-f319844da522"
          }],
          "product": {
            "gtin": "03907711316000",
            "label": "03907711316000 - Mon produit"
          }
        }]
      },
      "product": {
        "gtin": "03907711316000",
        "label": "03907711316000 - Mon produit"
      },
      "sourceOrganization": {
        "nameLegal": "Industriel"
      },
      "status": "AGREED",
      "targetOrganization": {
        "nameLegal": "Retailer"
      },
      "template": {
        "name": "Catalogue 2019",
        "status": "PUBLISHED",
        "uuid": "bce4f219-c40c-403a-af68-e867bc7388d7"
      },
      "updatedAt": "2019-05-17T09:12:21"
    }],
    "typePackaging": {
      "code": "EACH"
    },
    "updatedAt": "2019-05-17T09:12:29"
  }],
  "offset": 0,
  "totalResults": 1
}

In the following example a tariff with brackets has been linked to a product without specifying a logistical hierarchy:

{
    "data": [{
        "createdAt": "2019-05-17T09:11:30",
        "gtin": "03907711316000",
        "isConsumerUnit": true,
        "lifeCycle": 0,
        "supplierCode": "21421525141Fdfrsdfsdf",
 
        "namePublicLong": [{
            "data": "Mon produit",
            "expressedIn": {
                "code": "fra-FR"
            }
        }],
        "sharingUnits": [{
            "createdAt": "2019-05-15T12:38:15",
            "data": {
                "orderEndDate": "2019-05-30",
                "orderStartDate": "2019-05-09",
                "priceWaterfallBasisQuantityNumber": [{
                    "data": 5,
                    "expressedIn": {
                        "code": "BX",
                        "label": "box"
                    }
                }],
                "incotermCode": {
                    "code": "FCA"
                },
                "contractNumber": "234234dgsdfgdfg",
                "tariffNumber": "234234dgsdfgdfg",
                "contractYear": 2019,
                "targetCountryList": [
                    {
                     "targetCountryCode": {
                            "code": "10290",
                        }
                    }
                ],
                "currency": {
                    "code": "EUR"
                },
                "priceWaterfalls": [{
 
 
                    "bracketUnit": {
                        "code": "ctn",
                        "description": "Carton",
                        "label": "Carton"
                    },
                    "brackets": [{
                            "min": 1
                        },
                        {
                            "min": 10
                        }
                    ],
                    "levels": [{
                        "items": [{
                            "description": "Gross price",
                            "type": {
                                "code": "grossPrice",
                                "key": "grossPrice",
                                "label": "Gross price"
                            },
                            "uuid": "c088f3f6-7fa6-4115-9fba-8da83795f5de",
                            "values": [{
                                    "uuid": "ac195322-b9c6-4226-8fda-409341878973",
                                    "value": "13"
                                },
                                {
                                    "uuid": "33e91076-5b19-4f8e-b922-721bdbb3935b",
                                    "value": "12"
                                }
                            ]
                        }],
                        "type": {
                            "code": "price",
                            "description": "Price level type",
                            "label": "HT Tariff"
                        },
                        "uuid": "be51badf-ab10-40e2-85b0-bc92f3fab14b"
                    }],
                    "product": {
                        "gtin": "03907711316000"
                    }
                }]
            },
            "product": {
                "gtin": "03907711316000"
            },
            "sourceOrganization": {
                "nameLegal": "Industriel"
            },
            "status": "AGREED",
            "targetOrganization": {
                "nameLegal": "Retailer"
            },
            "template": {
                "name": "Catalogue 2019",
                "status": "PUBLISHED",
                "uuid": "bce4f219-c40c-403a-af68-e867bc7388d7"
            },
            "updatedAt": "2019-05-17T09:12:21"
        }],
        "typePackaging": {
            "code": "EACH"
        },
        "updatedAt": "2019-05-17T09:12:29"
    }],
    "offset": 0,
    "totalResults": 1
}