Skip to content
Stashtab Docs
Esc
↑↓navigate↵open⌘Jpreview

Get a purchase order

GET/v1/organizations/{orgId}/purchase-orders/{purchaseOrderId}
Authorization
AuthorizationBasic auth · headerrequired

Registered confidential integration credentials. Keep the secret server-side.

or
CookieAPI key · headerrequired

Console-managed Vault session cookie; secure cookie naming may vary by environment.

or
AuthorizationBearer token (Vault TEST service token) · headerrequired

Customer- and resource-bound service grant, rechecked on every call. Existing Live opening-feed authority remains narrow; ordinary Test business requests refuse until shared Test composition is available.

or
AuthorizationBearer token (Vault organization API key) · headerrequired

Organization-owned credential with immutable mode and Read-only or Read/write permissions. Only explicitly declared ordinary customer operations accept it. Test business access refuses until shared Test composition is available; no staff, team, key-management or protocol authority is granted.

Path parameters
orgIdstringrequired
min length 1 · max length 128 · matches ^[A-Za-z0-9_-]+$
purchaseOrderIdstring<uuid>required
matches ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
Responses
200

Success

dataobjectrequired
Show properties
createdAtstringrequired
declarationRevisionintegerrequired
min -9007199254740991 · max 9007199254740991
expectedDatestring | nullrequired
idstringrequired
kindstringrequired
Allowed:standardplayer_depositunexpected_goodsrestock
orderDatestring | nullrequired
originstringrequired
Allowed:customerstaff_unexpectedreturn_restock
poNumberstringrequired
providerPoRefstring | nullrequired
trackingstring | nullrequired
arrivalsobject[]required
Show properties
Array of object
arrivalIdentitystringrequired
idstringrequired
observedAtstringrequired
providerReceiptRefstring | nullrequired
countedobject | nullrequired
Show properties
Any of:
object
byConditionobject[]required
Show properties
Array of object
conditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
quantityintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
null
null
currencystring | nullrequired
declaredQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
linesobject[]required
Show properties
Array of object
baseSkustringrequired
countedobject | nullrequired
Show properties
Any of:
object
byConditionobject[]required
Show properties
Array of object
conditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
quantityintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
null
null
declaredConditionstring | nullrequired
Show properties
Any of:
string
string
null
null
declaredQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
idstringrequired
productBindingIdstring | nullrequired
revisionintegerrequired
min -9007199254740991 · max 9007199254740991
submittedNamestringrequired
supplierSkustring | nullrequired
variantBindingIdstring | nullrequired
varianceinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
notestring | nullrequired
orderNumberstring | nullrequired
providerReceivedobjectrequired
Show properties
One of:
object
linesobject[]required
Show properties
Array of object
orderedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
receivedQuantityintegerrequired
min -9007199254740991 · max 9007199254740991
skustringrequired
providerStatusstringrequired
statusstringrequired
object
issuestring | nullrequired
Show properties
Any of:
string
string
null
null
reasonstringrequired
Allowed:not_linkedaccount_unverifiedprovider_unavailableprovider_po_not_foundnot_receivingreport_invalid
statusstringrequired
undeclaredobject[]required
Show properties
Array of object
countedobjectrequired
Show properties
byConditionobject[]required
Show properties
Array of object
conditionstringrequired
Allowed:nmlpmphpdmgno_damage_found
quantityintegerrequired
min -9007199254740991 · max 9007199254740991
totalintegerrequired
min -9007199254740991 · max 9007199254740991
productBindingIdstringrequired
varianceinteger | nullrequired
Show properties
Any of:
integer
integer
null
null
metaobjectrequired
Show properties
requestIdstringrequired
default

Error

errorobjectrequired
Show properties
codestringrequired
Allowed:forbiddeninternal_errornot_foundprovider_data_invalidprovider_outcome_unknownprovider_unavailablerate_limitedstate_conflictunauthenticatedvalidation_errorwarehouse_not_ready
fieldsobject[]
Show properties
Array of object
codestringrequired
messagestringrequired
pathstringrequired
messagestringrequired
operationIdstring
metaobjectrequired
Show properties
requestIdstringrequired
Request
curl -X GET '/v1/organizations/string/purchase-orders/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Basic YOUR_CREDENTIALS' \
  -H 'Accept: application/json'
Response
{
  "data": {
    "createdAt": "string",
    "declarationRevision": -9007199254740991,
    "expectedDate": "string",
    "id": "string",
    "kind": "standard",
    "orderDate": "string",
    "origin": "customer",
    "poNumber": "string",
    "providerPoRef": "string",
    "tracking": "string",
    "arrivals": [
      {
        "arrivalIdentity": "string",
        "id": "string",
        "observedAt": "string",
        "providerReceiptRef": "string"
      }
    ],
    "counted": {
      "byCondition": [
        {
          "condition": "nm",
          "quantity": -9007199254740991
        }
      ],
      "total": -9007199254740991
    },
    "currency": "string",
    "declaredQuantity": -9007199254740991,
    "lines": [
      {
        "baseSku": "string",
        "counted": {
          "byCondition": [
            {
              "condition": "nm",
              "quantity": -9007199254740991
            }
          ],
          "total": -9007199254740991
        },
        "declaredCondition": "nm",
        "declaredQuantity": -9007199254740991,
        "id": "string",
        "productBindingId": "string",
        "revision": -9007199254740991,
        "submittedName": "string",
        "supplierSku": "string",
        "variantBindingId": "string",
        "variance": -9007199254740991
      }
    ],
    "note": "string",
    "orderNumber": "string",
    "providerReceived": {
      "lines": [
        {
          "orderedQuantity": -9007199254740991,
          "receivedQuantity": -9007199254740991,
          "sku": "string"
        }
      ],
      "providerStatus": "string",
      "status": "available"
    },
    "undeclared": [
      {
        "counted": {
          "byCondition": [
            {
              "condition": "nm",
              "quantity": -9007199254740991
            }
          ],
          "total": -9007199254740991
        },
        "productBindingId": "string"
      }
    ],
    "variance": -9007199254740991
  },
  "meta": {
    "requestId": "string"
  }
}

Was this page helpful?