Validate Distributor Purchase Order

post

https://{region}.api.jamfcloud.com/partners/v1/distributor/validate-purchase-order

Validates a distributor purchase order against the quote it references without submitting it, and returns the outcome of each validation rule that was evaluated. Use this to surface problems before calling POST /distributor/purchase-orders.

A Pass or Warning result does not guarantee that submission will succeed — validation is re-run on submission.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The purchase order to validate.

A distributor purchase order raised against a quote.

The schema is shared by requests and responses. On submission, supply the quote being ordered against, the distributor's own purchase order details, and the lines; the Jamf-assigned fields (jamfPoNumber, jamfOrderNumber, orderNumber, status, createdOn, lastModifiedOn, legalEntity) are populated by Jamf during processing and are ignored if supplied.

quoteNumber

string

Quote this purchase order is raised against, as returned by GET /distributor/quotes/{quoteNumber}.

poNumber

string

The distributor's own purchase order number.

poDate

date | null

Date the distributor raised the purchase order.

paymentTerms

string | null

Payment terms that apply to the order.

currencyCode

string

ISO 4217 currency code that totalAmount and all line amounts are denominated in. Must match the quote.

totalAmount

number | null

Total value of the purchase order in currencyCode. Validated against the quote total.

billingAddress

object

Address the order is billed to. Defaults to the quote's billing address when omitted.

shippingAddress

object

Address the order ships to. Defaults to the quote's shipping address when omitted.

lines

array of objects | null

Line items on the purchase order.

lines

Responses

Language

Credentials

OAuth2

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200The validation outcome. A response body is returned whether or not the purchase order is valid — inspect result to determine validity.

401Unauthorized. The access token is missing, invalid, or expired. The API Gateway rejects the request before it reaches the service.

403Forbidden. The token is not an external M2M token, or it does not carry the scope required to reach this endpoint.

404Not Found. The organization resolved from the access token is not registered as a Jamf distributor (NOT_FOUND), or the requested quote or purchase order does not exist for that distributor (UPSTREAM_ERROR).