Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 9 Next »

Provides the details of the PurchaseOrder either sent by a Customer, or retrieved by the Supplier from the Customer.

JSON Schema

OpenAPI Spec (POST)

OpenAPI Spec (GET)

Sample Payload

{
  "purchaseOrder": {
    "typeCode": "DropShip",
    "purchaseOrderHeader": {
      "identifier": "123232",
      "lastModificationDateTime": "2021-02-22T14:57:01-05:00",
      "note": "All order lines must ship together",
      "status": {
        "code": "Open"
      },
      "customerParty": {
        "identifier": "58885",
        "dunsid": "3434343",
        "accountIdentifier": "58885",
        "name": "LargeCustomerA"
      },
      "supplierParty": {},
      "shipToParty": {
        "identifier": "string",
        "name": "Large Customer Branch Plant B",
        "location": {
          "identifier": "Location1232321",
          "coordinate": {
            "verticalMeasure": "15Z",
            "latitudeMeasure": 45.0627402,
            "longitudeMeasure": -93.1624532
          },
          "physicalAddress": {
            "addressLine": [
              "1234 AnyStreet NW"
            ],
            "cityName": "St Paul",
            "countrySubDivisionCode": [
              {
                "content": "MN",
                "typeCode": "State"
              },
              {
                "content": "Ramsey",
                "typeCode": "County"
              }
            ],
            "countryCode": "USA",
            "postalCode": "55101-1111"
          },
          "glnid": "123456789"
        },
        "contact": {
          "typeCode": "Receiving Dock Contact",
          "personName": {
            "formattedName": "John E. Doe"
          },
          "telephoneCommunication": [
            {
              "typeCode": "Mobile",
              "identifier": "01.615.555.1234"
            }
          ],
          "emailAddressCommunication": {
            "identifier": "john.e.doe@emailaddress.com"
          }
        }
      },
      "contractReference": {
        "identifier": "contract123232"
      },
      "billToParty": {
        "identifier": "125484",
        "accountIdentifier": "1232323",
        "name": "Mary's Accounting Services"
      },
      "transportationTerm": {
        "freightTermCode": "DLV"
      },
      "tax": {
        "typeCode": "Sales",
        "amount": {
          "content": 19.753125,
          "currencyCode": "USD"
        }
      },
      "requestedShipDateTime": "2021-03-04T08:00:00-05:00"
    },
    "purchaseOrderLine": [
      {
        "actionCode": "Original",
        "lineNumberIdentifier": "1",
        "item": {
          "customerItemIdentification": {
            "identifier": "091818"
          },
          "manufacturerItemIdentification": {
            "typeCode": "SKU",
            "identifier": "1213579"
          },
          "supplierItemIdentification": {
            "typeCode": "SKU",
            "identifier": "1213579"
          },
          "upcid": "12323213213",
          "gtinid": "0012323213213",
          "description": "Item Description"
        },
        "quantity": {
          "content": 25,
          "unitCode": "EA"
        },
        "unitPrice": {
          "basisQuantity": {
            "content": 1,
            "unitCode": "EA"
          },
          "unitAmount": {
            "content": 10.5,
            "currencyCode": "USD"
          }
        },
        "extendedAmount": {
          "content": 262.5,
          "currencyCode": "USD"
        },
        "totalAmount": {
          "content": 282.253125,
          "currencyCode": "USD"
        },
        "tax": {
          "taxJurisdicationCodes": {
            "code": "CountyName"
          },
          "calculation": {
            "rateNumber": 0.07525
          },
          "amount": {
            "content": 19.753125,
            "currencyCode": "USD"
          },
          "currencyExchangeRate": {
            "sourceCurrencyCode": "USD",
            "targetCurrencyCode": "USD",
            "rateNumber": 1,
            "setDateTime": "2021-03-04T08:00:00-05:00"
          }
        },
        "specialPriceAuthorizationCode": "NA",
        "taxExemptCodes": {
          "code": [
            "NA"
          ]
        },
        "taxExemptIndicator": false
      }
    ]
  }
}
  • No labels