--- openapi: "3.0.2" info: title: "" description: "" contact: name: "" url: "" email: "example@example.org" version: "" paths: /acknowledgePurchaseOrder: summary: "" description: "" post: summary: "" description: "" tags: - "Acknowledge Purchase Order" requestBody: description: "" content: application/json: schema: $ref: "#/components/schemas/post-acknowledgePurchaseOrder-oagis-id-54b3ec0e633942a6978cfb0d37754ef4" responses: "200": description: "" content: application/json: {} components: schemas: normalizedString: type: "string" dateTime: type: "string" format: "date-time" token: type: "string" string: type: "string" decimal: type: "number" xbt_BooleanType: type: "boolean" post-acknowledgePurchaseOrder-oagis-id-54b3ec0e633942a6978cfb0d37754ef4: required: - "acknowledgePurchaseOrder" additionalProperties: false properties: acknowledgePurchaseOrder: type: "object" required: - "releaseIdentifier" - "applicationArea" - "dataArea" additionalProperties: false properties: releaseIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Static value for the OAGIS release" example: "10.7" applicationArea: type: "object" required: - "creationDateTime" additionalProperties: false properties: creationDateTime: $ref: "#/components/schemas/dateTime" dataArea: type: "object" required: - "acknowledge" - "purchaseOrder" additionalProperties: false properties: acknowledge: type: "object" additionalProperties: false properties: {} purchaseOrder: type: "array" minItems: 1 items: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "type of purchase order" example: "DropShip" purchaseOrderHeader: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Customer's purchase Order" example: "123232" lastModificationDateTime: allOf: - $ref: "#/components/schemas/dateTime" - description: "timestamp of the acknowledgement" example: "2021-02-23T09:52:01-05:00" status: description: "Status of the PO from the Seller's / Supplier\ \ perspective" type: "object" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Accepted, RequestedChange, Updated,\ \ In-process, Ready-to-ship" example: "RequestedChange" customerParty: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Customer Identifier" example: "58885" accountIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "account identifier for credit balance\ \ information" example: "58885" name: allOf: - $ref: "#/components/schemas/string" - example: "LargeCustomerA" supplierParty: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Supplier Identifier" example: "123454321" name: allOf: - $ref: "#/components/schemas/string" - example: "SmallBusinessA" contractReference: type: "object" additionalProperties: false properties: identifier: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/normalizedString" - example: "contract123232" totalAmount: description: "total order amount inclusive of taxes" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "500" currencyCode: allOf: - $ref: "#/components/schemas/token" - description: "currency code of the transaction" example: "USD" carrierParty: description: "Update to the PO and Sales order with the\ \ carrier is assigned." type: "object" additionalProperties: false properties: scacid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "RUAN" tax: description: "total tax amount" type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "type of tax" example: "Sales" amount: description: "amount of tax" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "19.753125" currencyCode: allOf: - $ref: "#/components/schemas/token" - description: "currency code" example: "USD" requestedShipDateTime: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/dateTime" - example: "2021-03-04T08:00:00-05:00" promisedShipDateTime: allOf: - $ref: "#/components/schemas/token" - description: "Promise ship date for all lines" example: "2021-03-04T08:00:00-05:00" promisedDeliveryDateTime: allOf: - $ref: "#/components/schemas/token" - example: "2021-03-10T08:00:00-05:00" salesOrderReference: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Supplier (NutraBlend) Sales Order\ \ identifier" example: "NB023032" purchaseOrderLine: type: "array" items: type: "object" additionalProperties: false properties: lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Customer's purchase order line" example: "1" note: allOf: - $ref: "#/components/schemas/string" - description: "Item may be substituted, a note is recommended" example: "We can ship partial now" status: description: "Status of line, including potential errors\ \ integrating the purchase order (see reason code\ \ and reason description)" type: "object" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Accepted, RequestedChange, Declined" example: "RequestedChange" reasonCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Reason Code if the line did not\ \ integrate" example: "SH" reason: type: "array" items: allOf: - $ref: "#/components/schemas/string" - description: "Reason detail message if the line\ \ did not integrate" example: "Raw Material Shortage" item: type: "object" additionalProperties: false properties: customerItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "091818" manufacturerItemIdentification: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - example: "SKU" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "1213579" upcid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "12323213213" gtinid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "0012323213213" description: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/string" - description: "description of the item" example: "Item Description" unitPrice: type: "object" additionalProperties: false properties: basisQuantity: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "1" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "EA" unitAmount: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "10.5" currencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" extendedAmount: description: "Total Amount = UnitPrice.UnitAmount *\ \ Quantity" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "262.5" currencyCode: allOf: - $ref: "#/components/schemas/token" - description: "currency code USD = US Dollars" example: "USD" totalAmount: allOf: - $ref: "#/components/schemas/decimal" - description: "Total Amount = UnitPrice.UnitAmount\ \ * Quantity + (if (TaxExemptIndicator=false) then\ \ Tax.Amount where ExtendedAmount *Tax.Calculation.RateNumber))" contractReference: type: "object" additionalProperties: false properties: identifier: $ref: "#/components/schemas/normalizedString" tax: description: "Indicates the tax for the order line ." type: "object" additionalProperties: false properties: calculation: type: "object" additionalProperties: false properties: rateNumber: allOf: - $ref: "#/components/schemas/decimal" - description: "Multiplier to get tax.amount" example: "0.07525" amount: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "19.753125" currencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" currencyExchangeRate: type: "object" additionalProperties: false properties: sourceCurrencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" targetCurrencyCode: allOf: - $ref: "#/components/schemas/token" - example: "USD" rateNumber: allOf: - $ref: "#/components/schemas/decimal" - example: "1" setDateTime: allOf: - $ref: "#/components/schemas/dateTime" - description: "date of currency exchange rate;\ \ typically the date of the transaction" example: "2021-03-04T08:00:00-05:00" specialPriceAuthorizationCode: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/normalizedString" - description: "Special Price Code - NA if not provided" example: "NA" promisedShipDateTime: allOf: - $ref: "#/components/schemas/token" - description: "promised ship date to meet the promised\ \ delivery date" example: "2021-03-04T08:00:00-05:00" promisedDeliveryDateTime: allOf: - $ref: "#/components/schemas/token" - description: "Date time which the line is promised\ \ to be delivered within reason" example: "2021-03-10T08:00:00-05:00" orderQuantity: description: "from original purchaseOrderLine.quantity" type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "25" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "EA" taxExemptCodes: type: "object" required: - "code" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - description: "if tax exempt indicator = true,\ \ then tax exempt code is required, else NA" example: "NA" shipFromParty: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "123454321" name: allOf: - $ref: "#/components/schemas/string" - example: "SmallBusinessA" location: description: "ShipFrom Location" type: "object" additionalProperties: false properties: name: allOf: - $ref: "#/components/schemas/string" - example: "SmallBusinessA WarehouseB" physicalAddress: description: "Physical address of the ship from\ \ location" type: "object" additionalProperties: false properties: addressLine: type: "array" items: allOf: - $ref: "#/components/schemas/string" - description: "Address Line of the ship\ \ from location" example: "1234 Warehouse Avenue North" cityName: allOf: - $ref: "#/components/schemas/string" - example: "Anytown" countrySubDivisionCode: type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/token" - example: "IA" typeCode: allOf: - $ref: "#/components/schemas/token" - example: "State" backOrderedQuantity: allOf: - $ref: "#/components/schemas/decimal" - description: "unable to commit this quantity" example: "2" openQuantity: allOf: - $ref: "#/components/schemas/decimal" - example: "23" salesOrderReference: description: "used to communicate the Supplier's sales\ \ order line that relates to customers purchase order\ \ line" type: "object" additionalProperties: false properties: lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "line on the supplier's sales order" example: "NB023032-1" taxExemptIndicator: allOf: - $ref: "#/components/schemas/xbt_BooleanType" - description: "if tax exempt, then true else false" example: "false"