This is a html view of the json schema please take the json schema as reference DOWNLOAD THE JSON SCHEMA

SupplierStocks

Type: object

In Pilot A supplier stock and its delivery promises by supplier facility and product.
This schema defines the structure for managing supplier stocks, including product details, stock quantity, unit of measure, production strategy, supplier facility information, eligible operating companies (OpCos), and modification date.
This is what a supplier is expected to send to Sonepar.


Example:

{
    "product": {
        "supplierProductId": "SUP-123456",
        "gtin": "0123456789012",
        "shortDescription": "Example Product Description"
    },
    "unitOfMeasure": "PCE",
    "productionStrategy": "MTS",
    "supplierFacility": {
        "facilityId": "FAC-001",
        "facilityName": "Main Warehouse",
        "facilityAddress": {
            "addressLine1": "Belleboslaan 17",
            "city": "Montesson",
            "country": "FRA",
            "postalCode": "78360",
            "department": "JURA",
            "region": "Bretagne"
        }
    },
    "eligibleOpCos": [
        {
            "opCoId": "BEL-CEBEO",
            "supplierId": "SUPPLIER-001",
            "deliveryPromisesRange": {
                "rangeStart": "P3D",
                "rangeEnd": "P5D"
            }
        },
        {
            "opCoId": "FRA-CONNECT",
            "supplierId": "SUPPLIER-002",
            "deliveryPromisesRange": {
                "rangeStart": "P2D",
                "rangeEnd": "P4D"
            }
        }
    ],
    "modifiedOn": "2023-10-01T12:00:00Z"
}

Type: object

The product associated with the stock.


Example:

{
    "supplierProductId": "SUP-123456",
    "gtin": "0123456789012"
}

Type: string

The unique identifier for the product provided by the supplier.


Example:

"SUP-123456"

Type: string

The Global Trade Item Number (GTIN) of the product. This is a unique identifier for trade items.


Example:

"0123456789012"

Type: string

A short description of the product.


Example:

"Example Product Description"

Type: integer

The stock quantity of the product. This is the number of items available in stock.

Value must be greater or equal to 0


Example:

100

Type: string

The unit of measure for the stock quantity. This is based on the GS1 standard codes (PCE, MTR, etc.). https://resources.gs1us.org/GS1-US-Data-Hub-Help-Center/ArtMID/3451/ArticleID/116/Unit-of-Measure-Codes


Examples:

"PCE"
"MTR"
"KGM"

Type: enum (of string) Default: "MTS"

The production strategy of the product. This can be
- MTS - Make to Stock : A production environment where products are finished before receipt of a customer order.
- MTO - Make to Order : A production environment where a good or service can be made after receipt of a customer's order
- ATO - Assemble to Order : refers to a hybrid production strategy that combines elements of both Make to Stock (MTS) and Make to Order (MTO).

Must be one of:

  • "MTS"
  • "MTO"
  • "ATO"

Type: object

The supplier facility where the stock is located.


Example:

{
    "facilityId": "FAC-001",
    "facilityName": "Main Warehouse",
    "facilityAddress": {
        "addressLine1": "Belleboslaan 17",
        "city": "Montesson",
        "country": "FRA",
        "postalCode": "78360",
        "department": "JURA",
        "region": "Bretagne"
    }
}

Type: string

The unique identifier for the supplier facility.

Type: string

The name of the supplier facility.

Type: object

The address of the supplier facility.


Example:

{
    "addressLine1": "Belleboslaan 17",
    "city": "Montesson",
    "country": "FRA",
    "postalCode": "78360",
    "department": "JURA",
    "region": "Bretagne"
}

Type: string

According to ISO 19060, this field contains one third of the address. In most cases this usually contains the whole addres though.


Example:

"Belleboslaan 17"

Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

Type: string

According to ISO 19060, this field contains one third of the address. This is an optional field.

Type: string

City.


Example:

"Montesson"

Type: string

The ISO 3166-1 alpha-3 of the country


Example:

"FRA"

Type: string

Zip code.


Example:

"78360"

Type: string

department


Example:

"JURA"

Type: string

region


Example:

"Bretagne"

Type: array

A list of operating companies (OpCos) that are eligible to use this stock.

Must contain a minimum of 1 items

No Additional Items

Each item of this array must be:

Type: object

An operating company (OpCo) that is eligible to use this stock.


Example:

{
    "opCoId": "BEL-CEBEO",
    "supplierId": "SUPPLIER-001",
    "deliveryPromisesRange": {
        "rangeStart": "P3D",
        "rangeEnd": "P5D"
    }
}

Type: enum (of string)

The unique identifier for the operating company (OpCo) that can use this stock.

Must be one of:

  • "BEL-CEBEO"
  • "FRA-CONNECT"
  • "NLD-TECUNIE"

Examples:

"BEL-CEBEO"
"FRA-CONNECT"
"NLD-TECUNIE"

Type: string

The Sonepar OpCo internal unique identifier for the supplier.

Must be at least 1 characters long


Example:

"SUPPLIER-001"

Type: object

A delivery promise range for a product by supplier facility and product. This includes the start and end of the delivery promise range. The range end can be equals to the range start, in this case it is considered to be a fixed delivery promise.


Example:

{
    "rangeStart": "P1W",
    "rangeEnd": "P2W"
}

Type: string

A duration in ISO 8601 format. We use the dur-day and the dur-week of the durations into ISO 8601 ABNF standard https://datatracker.ietf.org/doc/html/rfc3339#appendix-A


Examples:

"P3D"
"P1W"

Type: string

A duration in ISO 8601 format. We use the dur-day and the dur-week of the durations into ISO 8601 ABNF standard https://datatracker.ietf.org/doc/html/rfc3339#appendix-A


Examples:

"P3D"
"P1W"

Type: integer

The maximum order quantity for the product.

Value must be greater or equal to 0


Example:

100

Type: stringFormat: date-time

The date and time when the stock was last modified.


Example:

"2023-10-01T12:00:00Z"