--- openapi: "3.0.2" info: title: "" description: "" contact: name: "" url: "" email: "example@example.org" version: "" paths: /receiveDelivery: summary: "" description: "" post: summary: "" description: "" tags: - "Receive Delivery" requestBody: description: "" content: application/json: schema: $ref: "#/components/schemas/post-receiveDelivery-oagis-id-fe23e64e27424cb49d717ee1723522be" responses: "200": description: "" content: application/json: {} components: schemas: normalizedString: type: "string" token: type: "string" string: type: "string" dateTime: type: "string" format: "date-time" decimal: type: "number" xbt_BooleanType: type: "boolean" post-receiveDelivery-oagis-id-fe23e64e27424cb49d717ee1723522be: required: - "receiveDelivery" additionalProperties: false properties: receiveDelivery: type: "object" additionalProperties: false properties: receiveDeliveryHeader: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "shipment.identifier from NotifyShipment" example: "2130948342" lastModificationDateTime: allOf: - $ref: "#/components/schemas/token" - description: "create and last update timestamp" example: "2020-03-20T07:50:45.456-05:00" documentDateTime: allOf: - $ref: "#/components/schemas/token" - description: "original received timestamp - stays the same is\ \ there are updates" example: "2020-03-20T07:50:45.456-05:00" note: allOf: - $ref: "#/components/schemas/string" - description: "note sent back to vendor" documentReference: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Referenced purchaseOrder.identifier" example: "21231232" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "PurchaseOrder Reference" example: "PurchaseOrder" documentDateTime: allOf: - $ref: "#/components/schemas/token" - description: "date of purchaseOrder" example: "2020-03-15T15:45:17.456-06:00" status: type: "object" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - description: "received, partial, rejected" example: "received" billOfLadingReference: type: "object" additionalProperties: false properties: identifier: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/normalizedString" - example: "2130948342" documentDateTime: allOf: - $ref: "#/components/schemas/dateTime" - description: "print timestamp of BoL" example: "2020-03-19T17:00:45.456-05:00" contractReference: description: "Contract items received against" type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "identifier of the contract" example: "contract123232" actualDeliveryDateTime: allOf: - $ref: "#/components/schemas/dateTime" - description: "timestamp of actual delivery" example: "2021-03-04T12:48:00-05:00" tareWeightMeasure: description: "destination tare weights; e.g., on scale out actual\ \ weight after unload" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "35000" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "LB" netWeightMeasure: description: "destination net weight on scale out, this is calculate" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "1800" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "LB" grossWeightMeasure: description: "destination gross weights; scale in, actual weight\ \ with load." type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "36800" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "LB" transportationMethodCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Truck load, LTL (less than truckload), Rail, Ocean,\ \ Air" example: "TL" dockIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Loading docker identifier where items were received" example: "D-123232" carrierParty: type: "object" additionalProperties: false properties: scacid: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Carrier SCAC" example: "RUAN" name: allOf: - $ref: "#/components/schemas/string" - description: "Carrier's business Name" example: "Ruan Transportation" contact: description: "\nCarrier assigned dispatched Driver (Truck) or\ \ Operation (rail, ocean, air) " type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Identifier of Driver" example: "Badge1234" jobTitle: allOf: - $ref: "#/components/schemas/string" - description: "Driver or Operator" example: "Driver" supplierParty: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "supplier of the received items" example: "123454321" name: allOf: - $ref: "#/components/schemas/string" - description: "Name of the supplier party of the received items" example: "SmallSupplierA" shipToParty: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "identifier for the ship to party" example: "58885" name: allOf: - $ref: "#/components/schemas/string" - description: "ship to party name" example: "Happy Dairy Farm" location: description: "Ship to location" type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "Location1232321" coordinate: description: "coordinate for the physical location when\ \ a postal address (street id, postal code) is not defined,\ \ especially when ordered items are shipped to a construction\ \ site or agricultural location such as a field headland\ \ ." type: "object" additionalProperties: false properties: verticalMeasure: allOf: - $ref: "#/components/schemas/decimal" - example: "15" latitudeMeasure: allOf: - $ref: "#/components/schemas/decimal" - example: "43.580301503358996" longitudeMeasure: allOf: - $ref: "#/components/schemas/decimal" - example: "-92.57476726492425" physicalAddress: description: "Closest physical address related to the exact\ \ location product should be shipped, which may be specified\ \ in Coordinate.\nFor example, a farm physical address,\ \ when the product is shipped to a field." type: "object" additionalProperties: false properties: addressLine: type: "array" items: allOf: - $ref: "#/components/schemas/string" - example: "12345 Co Hwy 8" buildingNumber: allOf: - $ref: "#/components/schemas/string" - description: "Building number or Storage Location\ \ identifier" example: "2" buildingName: allOf: - $ref: "#/components/schemas/string" - description: "Building name or Storage Location name" example: "Storage Bin B" cityName: allOf: - $ref: "#/components/schemas/string" - description: "City " example: "Le Roy" countrySubDivisionCode: description: "County, state or province" type: "array" items: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/token" - example: "MN" typeCode: allOf: - $ref: "#/components/schemas/token" - description: "State , Province, County are permissible\ \ values" example: "State" countryCode: allOf: - $ref: "#/components/schemas/token" - description: "Use ISO 3166-3." example: "USA" postalCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Postal code" example: "55951-1234" glnid: allOf: - $ref: "#/components/schemas/normalizedString" - example: "123456789" contact: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - example: "Owner" personName: type: "object" additionalProperties: false properties: formattedName: allOf: - $ref: "#/components/schemas/string" - description: "First Name, Middle Initial., Last Name" example: "Mabel E. Farmer " telephoneCommunication: type: "array" items: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - example: "Mobile" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "phone number formatted with country\ \ code prefix" example: "01.507.555.1234" emailAddressCommunication: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "mabel.e.farmer@email.com" containerQuantity: allOf: - $ref: "#/components/schemas/decimal" - description: "count of containers; i.e., receiveDeliveryUnits\ \ (pallets, totes, etc)" example: "1" trackingIdentifier: oneOf: - nullable: true - $ref: "#/components/schemas/normalizedString" receiveDeliveryUnit: description: "pallet, tote, etc. which will contain one or more product/items" type: "array" items: type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "Type of shipment container, bulk, bulk cotote,\ \ pallet, etc." example: "Trailer" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "barcode or similar identifier of the pallet, tote,\ \ etc." example: "3243243243434" trackingIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "tracking identifier assigned by shipper" example: "4157451521254" proNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "tracking identifier assigned by carrier" example: "4157451521254" containerGroupIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "An identifier that groups shipping containers\ \ that must ship together to the same ShipTo location; e.g.,\ \ international shipments." example: "5" containerIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "trailer identifier " example: "C-12312323" rfid: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Id stored in the RFID tag" example: "0000000000000001" sealIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "seal identifier for certain types of shipping\ \ container when tramper proof logistics (e.g., food, grains)\ \ are required." example: "4157451521254" containsHazardousMaterialIndicator: oneOf: - nullable: true - allOf: - $ref: "#/components/schemas/xbt_BooleanType" - description: "if Hazardous Material is shipped then Y else\ \ N" example: "N" actualDeliveryDateTime: allOf: - $ref: "#/components/schemas/token" - description: "timestamp of barcode scan" example: "2020-03-20T07:50:45.456-05:00" tareWeightMeasure: oneOf: - nullable: true - $ref: "#/components/schemas/decimal" netWeightMeasure: $ref: "#/components/schemas/decimal" grossWeightMeasure: oneOf: - nullable: true - $ref: "#/components/schemas/decimal" receiveDeliveryUnitItem: description: "List of items within or on a receiveDeliveryUnit;\ \ i.e., pallet or tote. Many different types of items may be\ \ on a pallet." type: "array" items: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "item.identifier" example: "1" customerItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "customer's item identifier" example: "091818" manufacturerItemIdentification: description: "manufacturer's SKU if no GTIN is available" type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "SKU" example: "SKU" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "manufacturer's SKU if no GTIN is available" example: "1213579" supplierItemIdentification: type: "object" additionalProperties: false properties: identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Supplier's identifier, could be different\ \ than the manufacturer if supplier is a distributor" example: "1213579" upcid: allOf: - $ref: "#/components/schemas/normalizedString" - description: "manufacturer's UPC identifier" example: "NA" gtinid: allOf: - $ref: "#/components/schemas/normalizedString" - description: "GTIN of that item; GS1 maintained identifier" example: "NA" uid: allOf: - $ref: "#/components/schemas/normalizedString" - description: "barcoded string" example: "34343243434343" serialNumberIdentifier: type: "array" items: allOf: - $ref: "#/components/schemas/normalizedString" - description: "List of serialized identifier for individual\ \ packaged items, for example serialized jugs of crop\ \ protection." example: "NA" lot: description: "specific lot or batch of that item" type: "object" additionalProperties: false properties: typeCode: allOf: - $ref: "#/components/schemas/token" - description: "lot - when the finished goods item is\ \ assembled from other discrete items or is a discrete\ \ item\nbatch - when the finished goods item that\ \ have been mixed /blended with other items" example: "batch" identifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "lot or batch identifier:\nlot if homogeneous\ \ / assembled, \nbatch if mixture /formulated" example: "234415989" attachment: description: "suggest using MIME attachments, not embedded\ \ base64 for images due to parsing issues with base64\ \ in JSON streams. The character set overlaps, and exceptions\ \ can and have occurred parsing the JSON to well-formedness. " type: "array" items: type: "object" additionalProperties: false properties: fileName: allOf: - $ref: "#/components/schemas/string" - description: "The filename will appear in the HTTP\ \ boundary properties for multi-part attachments." example: "rodents.jpg" documentDateTime: allOf: - $ref: "#/components/schemas/dateTime" - description: "Timestamp of the photo." example: "2020-03-20T07:50:45.456-05:00" fileTypeCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "application/peg" fileSizeQuantity: allOf: - $ref: "#/components/schemas/decimal" - description: "content-length - byte count" example: "4343433" countryOfOriginCode: type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/token" - example: "USA" listIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - example: "3166-3" listAgencyIdentifier: allOf: - $ref: "#/components/schemas/token" - example: "ISO" results: description: "quality test results performed the receiving\ \ location, such as grain qualities (moisture, protein),\ \ both measured (quantitative) and observed (qualitative)" type: "object" additionalProperties: false properties: qualitative: description: "Observable, not measurable attributes\ \ of quality" type: "array" items: type: "object" additionalProperties: false properties: resultValue: type: "array" items: type: "object" required: - "content" - "name" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/string" - example: "A lot of broken pellets" name: allOf: - $ref: "#/components/schemas/string" - example: "Pellet Consistency" quantitative: description: "Measurable attributes of quality" type: "array" items: type: "object" additionalProperties: false properties: name: allOf: - $ref: "#/components/schemas/string" - example: "Moisture" significantDigitsNumber: allOf: - $ref: "#/components/schemas/decimal" - example: "5" measurement: type: "array" items: type: "object" required: - "measure" additionalProperties: false properties: dateTime: $ref: "#/components/schemas/dateTime" measure: allOf: - $ref: "#/components/schemas/decimal" - example: "11.23434" unitCode: allOf: - $ref: "#/components/schemas/normalizedString" - example: "PCT" orderQuantity: description: "original quantity ordered" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "2000" unitCode: allOf: - $ref: "#/components/schemas/token" - description: "UOM for the quantity ordered for that\ \ item" example: "LB" shippedQuantity: description: "original quantity shipped per NotifyShipment" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "1800" unitCode: allOf: - $ref: "#/components/schemas/token" - description: "UOM for actual shipped quantity" example: "LB" backOrderedQuantity: description: "quantity on back order" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "200" unitCode: allOf: - $ref: "#/components/schemas/token" - description: "UOM for quantity back ordered" example: "LB" purchaseOrderReference: type: "object" additionalProperties: false properties: lineNumberIdentifier: allOf: - $ref: "#/components/schemas/normalizedString" - description: "The line of the purchase order this\ \ item was specified" example: "123232-001" status: type: "object" additionalProperties: false properties: code: allOf: - $ref: "#/components/schemas/normalizedString" - description: "received, rejected, partial" example: "Received" reasonCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "If returned quantity > 0, then ReasonCode\ \ is required" example: "NA" reason: allOf: - $ref: "#/components/schemas/string" - description: "If returned quantity > 0, then Reason\ \ is required" example: "NA" receivedQuantity: description: "quantity received" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "1800" unitCode: allOf: - $ref: "#/components/schemas/token" - description: "UOM for Quantity actually received" example: "LB" returnedQuantity: description: "returned quantity due to a specific reason\ \ explained under receiptDiscrepancy" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "0" unitCode: allOf: - $ref: "#/components/schemas/token" - description: "UOM for quantity returned" example: "LB" receiptDiscrepancy: description: "Provides receiving discrepancy information\ \ for the ReceiveDelivery header as a whole, for a particular\ \ ReceiptLine, for the receipt of a shipping unit as a\ \ whole ReceiptLine, or to a particular item within the\ \ shipping unit (ReceiptUnit)." type: "object" additionalProperties: false properties: reasonCode: allOf: - $ref: "#/components/schemas/normalizedString" - description: "Reason code for return" example: "NA" itemQuantity: description: "quantity is question; shipper states x\ \ items shipped, but only y have been received." type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/decimal" - example: "0" unitCode: allOf: - $ref: "#/components/schemas/token" - example: "LB" note: description: "full text note specific to this item" type: "object" required: - "content" additionalProperties: false properties: content: allOf: - $ref: "#/components/schemas/string" - example: "I saw a few rodents in the trailer,\ \ but no droppings in the bulk boxes" author: allOf: - $ref: "#/components/schemas/string" - example: "Mabel" entryDateTime: allOf: - $ref: "#/components/schemas/dateTime" - example: "2020-03-20T07:50:45.456-05:00"