---
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-813ce25aa63c45478a8bf95c8532055f"
      responses:
        "200":
          description: ""
          content:
            application/json: {}
components:
  schemas:
    normalizedString:
      type: "string"
    token:
      type: "string"
    string:
      type: "string"
    decimal:
      type: "number"
    dateTime:
      type: "string"
      format: "date-time"
    post-receiveDelivery-oagis-id-813ce25aa63c45478a8bf95c8532055f:
      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"
                contractReference:
                  description: "Contract items received against"
                  type: "object"
                  additionalProperties: false
                  properties:
                    identifier:
                      allOf:
                      - $ref: "#/components/schemas/normalizedString"
                      - description: "identifier of the contract"
                        example: "contract123232"
                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"
                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"
                shipToParty:
                  type: "object"
                  additionalProperties: false
                  properties:
                    identifier:
                      allOf:
                      - $ref: "#/components/schemas/normalizedString"
                      - description: "id for ShipTo party"
                        example: "58885"
                    name:
                      allOf:
                      - $ref: "#/components/schemas/string"
                      - description: "Name of ShipTo party"
                        example: "Happy Dairy Farm"
                    location:
                      description: "location of ShipTo party"
                      type: "object"
                      additionalProperties: false
                      properties:
                        identifier:
                          allOf:
                          - $ref: "#/components/schemas/normalizedString"
                          - example: "Location1232321"
                containerQuantity:
                  allOf:
                  - $ref: "#/components/schemas/decimal"
                  - description: "count of containers; i.e., receiveDeliveryUnits\
                      \ (pallets, totes, etc)"
                    example: "1"
            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"
                  containerIdentifier:
                    allOf:
                    - $ref: "#/components/schemas/normalizedString"
                    - description: "trailer identifier "
                      example: "C-12312323"
                  rfid:
                    allOf:
                    - $ref: "#/components/schemas/normalizedString"
                    - example: "NA"
                  sealIdentifier:
                    allOf:
                    - $ref: "#/components/schemas/normalizedString"
                    - example: "4157451521254"
                  actualDeliveryDateTime:
                    allOf:
                    - $ref: "#/components/schemas/token"
                    - description: "timestamp of barcode scan"
                      example: "2020-03-20T07:50:45.456-05:00"
                  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"
                        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: "2343434343"
                        upcid:
                          allOf:
                          - $ref: "#/components/schemas/normalizedString"
                          - 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: "barcode"
                            example: "34343243434343"
                        serialNumberIdentifier:
                          type: "array"
                          items:
                            allOf:
                            - $ref: "#/components/schemas/normalizedString"
                            - example: "NA"
                        lot:
                          description: "specific lot or batch of that item"
                          type: "array"
                          items:
                            type: "object"
                            additionalProperties: false
                            properties:
                              typeCode:
                                allOf:
                                - $ref: "#/components/schemas/token"
                                - description: "lot or batch"
                                  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"
                        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"
                                example: "Partial"
                        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:
                          type: "object"
                          additionalProperties: false
                          properties:
                            reasonCode:
                              allOf:
                              - $ref: "#/components/schemas/normalizedString"
                              - description: "Reason code for return"
                                example: "NA"
                            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"