+
+
+
+ This aspect represents the remaining and planned production outputs of a supplier allocated to a customer. An allocated planned production output is described by a quantity, the site of the supplier and the date with time at which a production of a certain material for a certain customer is planned to be finished. The allocated planned production outputs may be linked to customer order position they have been scheduled for.
+
+
+
+
+
+ Overview
+
+
+
+
+
+
+
+ 
+
+
+
+
+
+
+Properties
+
+
+
+
+
+
+Material identifier as assigned by the customer. This material number identifies the material (as planned) in the customer's database. For standard parts (e.g. screws) for which a customer does not have an own number, the material number supplier should be set in this field, too.
+
+ Customer Material Number
+
+
+
+
+
+ Name
+ materialNumberCustomer
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ MNR-7307-AU340474.002
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ materialNumberCustomer
+
+
+
+
+
+
+
+
+
+Material identifier used uniquely to identify the Material (e.g. PartAsPlanned).
+
+ Material Number UUID of the Customer's Twin
+
+
+
+
+
+ Name
+ materialGlobalAssetId
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://tools.ietf.org/html/rfc4122 +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+ Payload key
+ materialGlobalAssetId
+
+
+Constraints
+
+
+-
+
-
++ +++ UUID v4 Regular Expression ++ +++ +Description+The provided regular expression ensures that the UUID is composed of five groups of characters separated by hyphens, in the form 8-4-4-4-12 for a total of 36 characters (32 hexadecimal characters and 4 hyphens), optionally prefixed by "urn:uuid:" to make it an IRI.+++ +Reference+++++
-
+
- https://datatracker.ietf.org/doc/html/rfc4122 +
++ + + +Regular expression+(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)+
+
+
+
+
+
+The positions refer to positions within an order of the given product (see material number supplier, materialNumber customer and material global Asset Id) for which the production outputs are transferred. The positions can be differentiated by the order position reference. If no order position reference is given, then there is only one position containing all planned production outputs of the product.
+
+ Positions
+
+
+
+
+
+ Name
+ positions
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Collection
+
+
+ Has no order
+
+
+ Duplicates allowed
+
+
+
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ positions
+
+
+
+
+
+
+Material identifier as assigned by the supplier. This material number identifies the material (as planned) in the supplier's database.
+
+ Supplier Material Number
+
+
+
+
+
+ Name
+ materialNumberSupplier
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ MNR-8101-ID146955.001
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ materialNumberSupplier
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.json b/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.json
new file mode 100644
index 00000000..ee3560b9
--- /dev/null
+++ b/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.json
@@ -0,0 +1,21 @@
+{
+ "positions" : [ {
+ "lastUpdatedOnDateTime" : "2023-04-01T14:23:00+01:00",
+ "orderPositionReference" : {
+ "supplierOrderId" : "M-Nbr-4711",
+ "customerOrderId" : "C-Nbr-4711",
+ "customerOrderPositionId" : "PositionId-01"
+ },
+ "allocatedPlannedProductionOutputs" : [ {
+ "plannedProductionQuantity" : {
+ "value" : 20.5,
+ "unit" : "unit:piece"
+ },
+ "productionSiteBpns" : "BPNS0123456789ZZ",
+ "estimatedTimeOfCompletion" : "2023-04-01T14:23:00+01:00"
+ } ]
+ } ],
+ "materialGlobalAssetId" : "urn:uuid:48878d48-6f1d-47f5-8ded-a441d0d879df",
+ "materialNumberCustomer" : "MNR-7307-AU340474.002",
+ "materialNumberSupplier" : "MNR-8101-ID146955.001"
+}
\ No newline at end of file
diff --git a/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.yml b/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.yml
new file mode 100644
index 00000000..4d8e9733
--- /dev/null
+++ b/io.catenax.planned_production_output/1.0.0/gen/PlannedProductionOutput.yml
@@ -0,0 +1,331 @@
+---
+openapi: 3.0.3
+info:
+ title: Planned Production Output of a Supplier
+ version: v1
+servers:
+- url: catenax.io/api/v1
+ variables:
+ api-version:
+ default: v1
+paths:
+ /{tenant-id}/planned-production-output:
+ get:
+ tags:
+ - PlannedProductionOutput
+ operationId: getPlannedProductionOutput
+ parameters:
+ - name: tenant-id
+ in: path
+ description: The ID of the tenant owning the requested Twin.
+ required: true
+ schema:
+ type: string
+ format: uuid
+ - name: start
+ in: query
+ description: Starting index which is starting by 0
+ required: false
+ schema:
+ type: number
+ - name: count
+ in: query
+ description: Number of items to return per call.
+ required: false
+ schema:
+ type: number
+ - name: totalItemCount
+ in: query
+ description: Flag that indicates that the total counts should be returned.
+ required: false
+ schema:
+ type: boolean
+ responses:
+ "200":
+ $ref: '#/components/responses/PlannedProductionOutput'
+ "401":
+ $ref: '#/components/responses/ClientError'
+ "402":
+ $ref: '#/components/responses/Unauthorized'
+ "403":
+ $ref: '#/components/responses/Forbidden'
+ "404":
+ $ref: '#/components/responses/NotFoundError'
+components:
+ schemas:
+ ErrorResponse:
+ type: object
+ required:
+ - error
+ properties:
+ error:
+ $ref: '#/components/schemas/Error'
+ Error:
+ type: object
+ required:
+ - details
+ properties:
+ message:
+ type: string
+ minLength: 1
+ path:
+ type: string
+ minLength: 1
+ details:
+ type: object
+ minLength: 1
+ additionalProperties:
+ type: object
+ code:
+ type: string
+ nullable: true
+ PagingSchema:
+ type: object
+ properties:
+ items:
+ type: array
+ items:
+ $ref: '#/components/schemas/PlannedProductionOutput'
+ totalItems:
+ type: number
+ totalPages:
+ type: number
+ pageSize:
+ type: number
+ currentPage:
+ type: number
+ urn_samm_io.catenax.planned_production_output_1.0.0_OrderIdCharacteristic:
+ type: string
+ description: "This is a proprietary order ID, generated by either the supplier\
+ \ side or customer side."
+ urn_samm_io.catenax.planned_production_output_1.0.0_OrderPositionIdCharacteristic:
+ type: string
+ description: The position ID is unique for an order and used within business
+ context to refer to a position.
+ urn_samm_io.catenax.planned_production_output_1.0.0_OrderPositionReferenceCharacteristic:
+ description: "The order position reference includes reference numbers for the\
+ \ order and the position. As these information are meant for the customer,\
+ \ the customer reference numbers are mandatory."
+ type: object
+ properties:
+ supplierOrderId:
+ description: "This is the order number on the supplier side that is given\
+ \ by e.g., the supplier's enterprise resource planning system."
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_OrderIdCharacteristic'
+ customerOrderId:
+ description: "This is the order number on the customer side that can be\
+ \ given by e.g., the customer's enterprise resource planning system."
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_OrderIdCharacteristic'
+ customerOrderPositionId:
+ description: "This is an identifier for the position of an order defined\
+ \ by the customer. It's not a technical identifier, such as an UUID. This\
+ \ identifier is used within the business context when talking about the\
+ \ position."
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_OrderPositionIdCharacteristic'
+ required:
+ - customerOrderId
+ - customerOrderPositionId
+ urn_samm_io.catenax.planned_production_output_1.0.0_DateTimeStamp:
+ type: string
+ pattern: "-?([1-9][0-9]{3,}|0[0-9]{3})-(0[1-9]|1[0-2])-(0[1-9]|[12][0-9]|3[01])T(([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9](\\\
+ .[0-9]+)?|(24:00:00(\\.0+)?))(Z|(\\+|-)((0[0-9]|1[0-3]):[0-5][0-9]|14:00))?"
+ description: The Date with the timezone.
+ urn_samm_io.catenax.shared.quantity_1.0.0_QuantityValueCharacteristic:
+ type: number
+ description: The quantity value associated with the unit expressed as float.
+ urn_samm_io.catenax.shared.quantity_1.0.0_ItemUnitEnumeration:
+ type: string
+ pattern: "[a-zA-Z]*:[a-zA-Z]+"
+ description: Enumeration for common item units.
+ enum:
+ - unit:piece
+ - unit:set
+ - unit:pair
+ - unit:page
+ - unit:cycle
+ - unit:kilowattHour
+ - unit:gram
+ - unit:kilogram
+ - unit:tonneMetricTon
+ - unit:tonUsOrShortTonUkorus
+ - unit:ounceAvoirdupois
+ - unit:pound
+ - unit:metre
+ - unit:centimetre
+ - unit:kilometre
+ - unit:inch
+ - unit:foot
+ - unit:yard
+ - unit:squareCentimetre
+ - unit:squareMetre
+ - unit:squareInch
+ - unit:squareFoot
+ - unit:squareYard
+ - unit:cubicCentimetre
+ - unit:cubicMetre
+ - unit:cubicInch
+ - unit:cubicFoot
+ - unit:cubicYard
+ - unit:litre
+ - unit:millilitre
+ - unit:hectolitre
+ - unit:secondUnitOfTime
+ - unit:minuteUnitOfTime
+ - unit:hourUnitOfTime
+ - unit:day
+ urn_samm_io.catenax.planned_production_output_1.0.0_QuantityCharacteristic:
+ description: Describes the quantity and the unit of measure with which the planned
+ and allocated production output is measured.
+ type: object
+ properties:
+ value:
+ description: The quantity value associated with the unit.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_1.0.0_QuantityValueCharacteristic'
+ unit:
+ description: "The unit of an item. Common units may be related to mass,\
+ \ count, linear, area, volume or misc."
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.quantity_1.0.0_ItemUnitEnumeration'
+ required:
+ - value
+ - unit
+ urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnsTrait:
+ type: string
+ description: "The provided regular expression ensures that the BPNS is composed\
+ \ of prefix 'BPNS', 10 digits and two uppercase letters."
+ pattern: "^BPNS[0-9]{8}[a-zA-Z0-9]{4}$"
+ urn_samm_io.catenax.planned_production_output_1.0.0_AllocatedPlannedProductionOutput:
+ description: "Quantity, site of the supplier and date with time at which a production\
+ \ of a certain material for a certain customer is planned to be finished."
+ type: object
+ properties:
+ plannedProductionQuantity:
+ description: "Quantity of a product that a supplier plans to produce on\
+ \ a certain date and time for a specific customer (that means that it\
+ \ will be allocated to a specific customer's \"allocated item stock\"\
+ ).\nQuantities that have already been produced are put on stock or are\
+ \ considered for delivery. Therefore those quantities MUST NOT be considered\
+ \ in the allocated production output to build a consistent view on the\
+ \ supply situation. "
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_QuantityCharacteristic'
+ productionSiteBpns:
+ description: One planned and allocated production output has always one
+ site. The site is identified by the BPNS.
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.business_partner_number_1.0.0_BpnsTrait'
+ estimatedTimeOfCompletion:
+ description: Date and time on which the planned and allocated production
+ output is estimated to be completed. Date and time are set according to
+ a timezone.
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_DateTimeStamp'
+ required:
+ - plannedProductionQuantity
+ - productionSiteBpns
+ - estimatedTimeOfCompletion
+ urn_samm_io.catenax.planned_production_output_1.0.0_AllocatedPlannedProductionOutputCollection:
+ description: Collection of planned and allocated production outputs that may
+ relate to different production locations and estimated time of completions.
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_AllocatedPlannedProductionOutput'
+ urn_samm_io.catenax.planned_production_output_1.0.0_Position:
+ description: The Position can be planned for production at several sites. A
+ position may be anonymous or may reference a position within an order.
+ type: object
+ properties:
+ orderPositionReference:
+ description: The order position reference contains information to identify
+ a position within an order.
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_OrderPositionReferenceCharacteristic'
+ lastUpdatedOnDateTime:
+ description: Date and time at which the position has been updated by the
+ supplier's systems. Date and time are set according to the timezone.
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_DateTimeStamp'
+ allocatedPlannedProductionOutputs:
+ description: Planned Production Outputs already allocated to the customer.
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_AllocatedPlannedProductionOutputCollection'
+ required:
+ - lastUpdatedOnDateTime
+ - allocatedPlannedProductionOutputs
+ urn_samm_io.catenax.planned_production_output_1.0.0_PositionsCollection:
+ description: "If any production for the customer is planned, then there is at\
+ \ least one position. If the supplier does differentiate the planned production\
+ \ according to the order positions (an OrderPositionReference is set), then\
+ \ multiple positions can be given. Among the positions, there could be only\
+ \ one position without an OrderPositionReference to either report the planned\
+ \ production independently of orders or to report internal stock orders planned\
+ \ for the customer."
+ type: array
+ items:
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_Position'
+ urn_samm_io.catenax.planned_production_output_1.0.0_MaterialNumberCharacteristic:
+ type: string
+ description: "The material number is a multi-character string, usually assigned\
+ \ by an ERP system."
+ urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait:
+ type: string
+ description: "The provided regular expression ensures that the UUID is composed\
+ \ of five groups of characters separated by hyphens, in the form 8-4-4-4-12\
+ \ for a total of 36 characters (32 hexadecimal characters and 4 hyphens),\
+ \ optionally prefixed by \"urn:uuid:\" to make it an IRI."
+ pattern: "(^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)|(^urn:uuid:[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$)"
+ PlannedProductionOutput:
+ description: "This aspect represents the remaining and planned production outputs\
+ \ of a supplier allocated to a customer. An allocated planned production output\
+ \ is described by a quantity, the site of the supplier and the date with time\
+ \ at which a production of a certain material for a certain customer is planned\
+ \ to be finished. The allocated planned production outputs may be linked to\
+ \ customer order position they have been scheduled for."
+ type: object
+ properties:
+ positions:
+ description: "The positions refer to positions within an order of the given\
+ \ product (see material number supplier, materialNumber customer and material\
+ \ global Asset Id) for which the production outputs are transferred. The\
+ \ positions can be differentiated by the order position reference. If\
+ \ no order position reference is given, then there is only one position\
+ \ containing all planned production outputs of the product."
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_PositionsCollection'
+ materialNumberCustomer:
+ description: "Material identifier as assigned by the customer. This material\
+ \ number identifies the material (as planned) in the customer's database.\
+ \ For standard parts (e.g. screws) for which a customer does not have\
+ \ an own number, the material number supplier should be set in this field,\
+ \ too."
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_MaterialNumberCharacteristic'
+ materialGlobalAssetId:
+ description: Material identifier used uniquely to identify the Material
+ (e.g. PartAsPlanned).
+ $ref: '#/components/schemas/urn_samm_io.catenax.shared.uuid_1.0.0_UuidV4Trait'
+ materialNumberSupplier:
+ description: Material identifier as assigned by the supplier. This material
+ number identifies the material (as planned) in the supplier's database.
+ $ref: '#/components/schemas/urn_samm_io.catenax.planned_production_output_1.0.0_MaterialNumberCharacteristic'
+ required:
+ - positions
+ - materialNumberCustomer
+ responses:
+ Unauthorized:
+ description: The requesting user or client is not authenticated.
+ Forbidden:
+ description: The requesting user or client is not authorized to access resources
+ for the given tenant.
+ NotFoundError:
+ description: The requested Twin has not been found.
+ ClientError:
+ description: Payload or user input is invalid. See error details in the payload
+ for more.
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/ErrorResponse'
+ PlannedProductionOutput:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PagingSchema'
+ description: The request was successful.
+ requestBodies:
+ PlannedProductionOutput:
+ content:
+ application/json:
+ schema:
+ $ref: '#/components/schemas/PlannedProductionOutput'
+
+
+ Entities
+
+
+
+
+ Item Quantity Entity
+
+ Entity for common measurements of an item (mass, count, linear, area, volume, misc) with an unit and a value.
+
+
+
+
+Properties
+
+
+
+
+
+
+The quantity value associated with the unit.
+
+ Quantity Value
+
+
+
+
+
+ Name
+ quantityValue
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Quantifiable
+
+
+ Duration
+
+
+ The quantity value associated with the unit expressed as float.
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#float
+
+
+
+
+
+ Example
+ 20.5
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ value
+
+
+
+
+
+
+The unit of an item. Common units may be related to mass, count, linear, area, volume or misc.
+
+ Item Unit
+
+
+
+
+
+ Name
+ itemUnit
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Enumeration
+
+
+ Values
+
+
+
+
+ -
+
- unit:piece +
- unit:set +
- unit:pair +
- unit:page +
- unit:cycle +
- unit:kilowattHour +
- unit:gram +
- unit:kilogram +
- unit:tonneMetricTon +
- unit:tonUsOrShortTonUkorus +
- unit:ounceAvoirdupois +
- unit:pound +
- unit:metre +
- unit:centimetre +
- unit:kilometre +
- unit:inch +
- unit:foot +
- unit:yard +
- unit:squareCentimetre +
- unit:squareMetre +
- unit:squareInch +
- unit:squareFoot +
- unit:squareYard +
- unit:cubicCentimetre +
- unit:cubicMetre +
- unit:cubicInch +
- unit:cubicFoot +
- unit:cubicYard +
- unit:litre +
- unit:millilitre +
- unit:hectolitre +
- unit:secondUnitOfTime +
- unit:minuteUnitOfTime +
- unit:hourUnitOfTime +
- unit:day +
+
+
+ Reference
+
+
+
+ -
+
- https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html +
+
+
+
+
+
+ Example
+ unit:piece
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+ Payload key
+ unit
+
+
+
+Reference
+
+
+ -
+
- https://eclipse-esmf.github.io/samm-specification/2.1.0/index.html +
+
+
+
+
+ Planned and Allocated Production Output
+
+ Quantity, site of the supplier and date with time at which a production of a certain material for a certain customer is planned to be finished.
+
+
+
+
+Properties
+
+
+
+
+
+
+Quantity of a product that a supplier plans to produce on a certain date and time for a specific customer (that means that it will be allocated to a specific customer's "allocated item stock").
+Quantities that have already been produced are put on stock or are considered for delivery. Therefore those quantities MUST NOT be considered in the allocated production output to build a consistent view on the supply situation.
+
+ Planned Production Quantity
+
+
+
+
+
+ Name
+ plannedProductionQuantity
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Quantifiable
+
+
+ Duration
+
+
+ Describes the quantity and the unit of measure with which the planned and allocated production output is measured.
+
+
+
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ plannedProductionQuantity
+
+
+
+
+
+
+One planned and allocated production output has always one site. The site is identified by the BPNS.
+
+ BPNS of Supplier's Production Site
+
+
+
+
+
+ Name
+ productionSiteBpns
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Trait
+
+
+
+ Reference
+
+
+
+ -
+
- https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf +
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ BPNS0123456789ZZ
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+ Payload key
+ productionSiteBpns
+
+
+
+ Reference
+
+
+ -
+
- https://catena-x.net/fileadmin/user_upload/Standard-Bibliothek/Update_PDF_Maerz/5_BPDM/CX_-_0010_BUSINESS_PARTNER_NUMBER_PlatformCapabilityBPDM_v_1.0.1.pdf +
+
+Constraints
+
+
+-
+
-
++ +++ BPNS Regular Expression ++ +++ + +Description+The provided regular expression ensures that the BPNS is composed of prefix 'BPNS', 10 digits and two uppercase letters.+++ + + +Regular expression+^BPNS[0-9]{8}[a-zA-Z0-9]{4}$+
+
+
+
+
+
+Date and time on which the planned and allocated production output is estimated to be completed. Date and time are set according to a timezone.
+
+ Estimated Time of Completion
+
+
+
+
+
+ Name
+ estimatedTimeOfCompletion
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Reference
+
+
+
+ -
+
- https://www.iso.org/iso-8601-date-and-time-format.html +
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Example
+ 2023-04-01T14:23:00+01:00
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ estimatedTimeOfCompletion
+
+
+
+
+ Position
+
+ The Position can be planned for production at several sites. A position may be anonymous or may reference a position within an order.
+
+
+
+
+Properties
+
+
+
+
+
+
+The order position reference contains information to identify a position within an order.
+
+ Order Position Reference
+
+
+
+
+
+ Name
+ orderPositionReference
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ SingleEntity
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ orderPositionReference
+
+
+
+
+
+
+Date and time at which the position has been updated by the supplier's systems. Date and time are set according to the timezone.
+
+ Lasted Updated on Date
+
+
+
+
+
+ Name
+ lastUpdatedOnDateTime
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Reference
+
+
+
+ -
+
- https://www.iso.org/iso-8601-date-and-time-format.html +
+
+
+ Type http://www.w3.org/2001/XMLSchema#dateTime
+
+
+
+
+
+ Example
+ 2023-04-01T14:23:00+01:00
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ lastUpdatedOnDateTime
+
+
+
+
+
+
+Planned Production Outputs already allocated to the customer.
+
+ Planned and Allocated Production Outputs
+
+
+
+
+
+ Name
+ allocatedPlannedProductionOutputs
+
+
+
+
+ Characteristic
+
+
+
+
+
+
+ Collection
+
+
+ Has no order
+
+
+
+ Duplicates allowed
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ allocatedPlannedProductionOutputs
+
+
+
+
+ Reference to Order Position
+
+ Encapsulates the references to identify a position within an order.
+
+
+
+
+Properties
+
+
+
+
+
+
+This is the order number on the supplier side that is given by e.g., the supplier's enterprise resource planning system.
+
+ Supplier Order ID
+
+
+
+
+
+ Name
+ supplierOrderId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ M-Nbr-4711
+
+
+
+ Optional
+
+ Yes
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ supplierOrderId
+
+
+
+
+
+
+This is the order number on the customer side that can be given by e.g., the customer's enterprise resource planning system.
+
+ Customer Order ID
+
+
+
+
+
+ Name
+ customerOrderId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ C-Nbr-4711
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ customerOrderId
+
+
+
+
+
+
+This is an identifier for the position of an order defined by the customer. It's not a technical identifier, such as an UUID. This identifier is used within the business context when talking about the position.
+
+ Customer Order Position ID
+
+
+
+
+
+ Name
+ customerOrderPositionId
+
+
+
+ Characteristic
+
+
+
+
+
+
+
+ Type http://www.w3.org/2001/XMLSchema#string
+
+
+
+
+
+ Example
+ PositionId-01
+
+
+
+ Optional
+
+ No
+
+
+
+ In payload
+
+ Yes
+
+
+
+
+Payload key
+ customerOrderPositionId
+
+ Third party licenses
+
+
+
+