PRprodigi
Orders

This endpoint submits and creates your order in Prodigi

Changed on
post/v4.0/Orders

Request

  • Base URL
    https://api.prodigi.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.prodigi.com/v4.0/Orders
  • Auth
    API key in header X-API-Key

Query parameters

validationOnlyboolean nullable

Only validate the order data.

Request body

omsIdinteger nullable
callbackUrlstring uri nullable
merchantReferencestring nullable
idempotencyKeystring nullable
shippingMethodstring nullable
brandingobject nullable
metadataOrderJToken[] circular
tagstring nullable
usSalesTaxAlreadyCollectedboolean

Response

Returns the created order details with an outcome of created, createdWithIssues or alreadyExists

outcomestring nullable
traceParentstring nullable

Changes

  • dfdea1755858Revision changes
    • info

      added the new optional request property /// (media type: application/json-patch+json)

    • info

      added the new optional request property /// (media type: application/json)

    • info

      added the new optional request property /// (media type: text/json)

    • info

      added the new optional request property /// (media type: application/*+json)

    • info

      added the new optional request property /// (media type: application/json-patch+json)

    • info

      added the new optional request property /// (media type: application/json)

    • info

      added the new optional request property /// (media type: text/json)

    • info

      added the new optional request property /// (media type: application/*+json)

    • info

      added the optional property //// to the response with the status

    • info

      added the optional property //// to the response with the status