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

ProductStocks

Type: object

An array of product stock details based on the facilities

 No Additional Properties

If the conditions in the "If" tab are respected, then the conditions in the "Then" tab should be respected. Otherwise, the conditions in the "Else" tab should be respected.

root if
Type: object

root if action
Type: const
Specific value: "PATCH"
root then
Type: object

root then stocks
Type: array
No Additional Items

Each item of this array must be:

root then stocks StockPatch
Type: object
No Additional Properties

root then stocks stocks items facilityId
Type: string

branch or location id where the stock exists
Example:

"9554961192345"

root then stocks stocks items quantity
Type: integer

the actual quantity of the available stock. field unitOfMeasure must be set if quantity is set

Value must be greater or equal to 0


Example:

14

root then stocks stocks items unitOfMeasure
Type: enum (of string)

the unit of measure in which the product is being sold, 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
field quantity must be set if unitOfMeasure is set

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"PCE"

root then stocks stocks items deliveryPromiseRange
Type: object

Minimum and maximum duration in which the product can be delivered to the customer.
Examples:

{
    "min": "P1D",
    "max": "P3D"
}

{
    "min": "P1W",
    "max": "P2W"
}

root then stocks stocks items deliveryPromiseRange min
Type: stringFormat: duration

The minimal duration that this product will take to be delivered to the customer. 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"

"P3W"

root then stocks stocks items deliveryPromiseRange max
Type: stringFormat: duration

The maximal duration that this product will take to be delivered to the customer. 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:

"P5D"

"P5W"

root then stocks stocks items inboundDeliveryDate
Type: stringFormat: date-time

If the stock is unavailable but it is already confirmed as a purchase order and has a confirmation date for delivery at CDC (required to calculate the lead time), In other case if the product has not been back ordered then opcos could provide information based on general value or use some 3rd party options to compute this time to help calculate the delivery promise
Example:

"2021-10-12T08:30:22.804Z"

root then stocks stocks items excludedForExtendedDelivery
Type: boolean Default: "false"

If the stock should not be considered for extended delivery (multi-cdc), then should be sent as 'true'. Default is false that implies that the stock on this facility is available for extended delivery.
Examples:

"false"

"true"
root else
Type: object

root else stocks
Type: array
No Additional Items

Each item of this array must be:

root else stocks Stocks
Type: object
No Additional Properties

root else stocks stocks items facilityId
Type: string

branch or location id where the stock exists
Example:

"9554961192345"

root else stocks stocks items quantity
Type: integer

the actual quantity of the available stock

Value must be greater or equal to 0


Example:

14

root else stocks stocks items unitOfMeasure
Type: enum (of string)

the unit of measure in which the product is being sold, 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

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"

root else stocks stocks items deliveryPromiseRange
Type: object

Minimum and maximum duration in which the product can be delivered to the customer.
Examples:

{
    "min": "P1D",
    "max": "P3D"
}

{
    "min": "P1W",
    "max": "P2W"
}

root else stocks stocks items deliveryPromiseRange min
Type: stringFormat: duration

The minimal duration that this product will take to be delivered to the customer. 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"

"P3W"

root else stocks stocks items deliveryPromiseRange max
Type: stringFormat: duration

The maximal duration that this product will take to be delivered to the customer. 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:

"P5D"

"P5W"

root else stocks stocks items inboundDeliveryDate
Type: stringFormat: date-time

If the stock is unavailable but it is already confirmed as a purchase order and has a confirmation date for delivery at CDC (required to calculate the lead time), In other case if the product has not been back ordered then opcos could provide information based on general value or use some 3rd party options to compute this time to help calculate the delivery promise
Example:

"2021-10-12T08:30:22.804Z"

root else stocks stocks items excludedForExtendedDelivery
Type: boolean Default: "false"

If the stock should not be considered for extended delivery (multi-cdc), then should be sent as 'true'. Default is false that implies that the stock on this facility is available for extended delivery.
Examples:

"false"

"true"

root productId
Type: string

unique product identifier of the product

root action
Type: enum (of string) Default: "UPSERT"

Action to be taken for the Stock update. If not provided by the OpCo, UPSERT will be used by default

Must be one of:

  • "UPSERT"
  • "PATCH"

root stocks
Type: array

list of stocks

 No Additional Items

Each item of this array must be:

root stocks stocks items

root stocks stocks items anyOf Stocks
Type: object
No Additional Properties

root stocks stocks items anyOf item 0 facilityId
Type: string

branch or location id where the stock exists
Example:

"9554961192345"

root stocks stocks items anyOf item 0 quantity
Type: integer

the actual quantity of the available stock

Value must be greater or equal to 0


Example:

14

root stocks stocks items anyOf item 0 unitOfMeasure
Type: enum (of string)

the unit of measure in which the product is being sold, 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

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"

root stocks stocks items anyOf item 0 deliveryPromiseRange
Type: object

Minimum and maximum duration in which the product can be delivered to the customer.
Examples:

{
    "min": "P1D",
    "max": "P3D"
}

{
    "min": "P1W",
    "max": "P2W"
}

root stocks stocks items anyOf item 0 deliveryPromiseRange min
Type: stringFormat: duration

The minimal duration that this product will take to be delivered to the customer. 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"

"P3W"

root stocks stocks items anyOf item 0 deliveryPromiseRange max
Type: stringFormat: duration

The maximal duration that this product will take to be delivered to the customer. 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:

"P5D"

"P5W"

root stocks stocks items anyOf item 0 inboundDeliveryDate
Type: stringFormat: date-time

If the stock is unavailable but it is already confirmed as a purchase order and has a confirmation date for delivery at CDC (required to calculate the lead time), In other case if the product has not been back ordered then opcos could provide information based on general value or use some 3rd party options to compute this time to help calculate the delivery promise
Example:

"2021-10-12T08:30:22.804Z"

root stocks stocks items anyOf item 0 excludedForExtendedDelivery
Type: boolean Default: "false"

If the stock should not be considered for extended delivery (multi-cdc), then should be sent as 'true'. Default is false that implies that the stock on this facility is available for extended delivery.
Examples:

"false"

"true"
root stocks stocks items anyOf StockPatch
Type: object

If unit of measure is present then quantity must be set and vice versa

 No Additional Properties

root stocks stocks items anyOf item 1 facilityId
Type: string

branch or location id where the stock exists
Example:

"9554961192345"

root stocks stocks items anyOf item 1 quantity
Type: integer

the actual quantity of the available stock. field unitOfMeasure must be set if quantity is set

Value must be greater or equal to 0


Example:

14

root stocks stocks items anyOf item 1 unitOfMeasure
Type: enum (of string)

the unit of measure in which the product is being sold, 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
field quantity must be set if unitOfMeasure is set

Must be one of:

  • "FOT"
  • "PCE"
  • "MTR"
  • "KGM"
  • "CMT"
  • "LTR"
  • "EA"
  • "MTK"
  • "PK"
  • "MTQ"
  • "TN"
  • "MLT"
  • "BG"
  • "PR"
  • "RO"
  • "SET"
  • "LN"
  • "ST"
  • "RL"
  • "BX"
  • "CS"
  • "JR"
  • "LBR"
  • "INH"
  • "DZN"
  • "SO"
  • "CL"
  • "CG"
  • "CT"

Example:

"PCE"

root stocks stocks items anyOf item 1 deliveryPromiseRange
Type: object

Minimum and maximum duration in which the product can be delivered to the customer.
Examples:

{
    "min": "P1D",
    "max": "P3D"
}

{
    "min": "P1W",
    "max": "P2W"
}

root stocks stocks items anyOf item 1 deliveryPromiseRange min
Type: stringFormat: duration

The minimal duration that this product will take to be delivered to the customer. 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"

"P3W"

root stocks stocks items anyOf item 1 deliveryPromiseRange max
Type: stringFormat: duration

The maximal duration that this product will take to be delivered to the customer. 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:

"P5D"

"P5W"

root stocks stocks items anyOf item 1 inboundDeliveryDate
Type: stringFormat: date-time

If the stock is unavailable but it is already confirmed as a purchase order and has a confirmation date for delivery at CDC (required to calculate the lead time), In other case if the product has not been back ordered then opcos could provide information based on general value or use some 3rd party options to compute this time to help calculate the delivery promise
Example:

"2021-10-12T08:30:22.804Z"

root stocks stocks items anyOf item 1 excludedForExtendedDelivery
Type: boolean Default: "false"

If the stock should not be considered for extended delivery (multi-cdc), then should be sent as 'true'. Default is false that implies that the stock on this facility is available for extended delivery.
Examples:

"false"

"true"