v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Confirm Receipt Standard Service

getConfirmReceiptsStandardByPage

Retrieve a list of Confirm Receipt details by page number.

get/confirmreceiptstandard/v1/getConfirmReceiptsStandardByPage

Query parameters

accountNumberstring

Account Number to explicitly retrieve.

confirmReceiptDatestring

Retrieve orders with confirm receipt date equal to this date.

locationCodestring

The Code that identifies the Location in Crunchtime.

pageNumberinteger

Retrieve one or more records by pageNumber. \n Use to retrieve data in smaller chunks. \n If left blank, the default is 1.

pageSizeinteger

Number of items to display per page.

purchaseOrderNumberstring

Order Number of purchase order to retrieve.

trackingNumberstring

Tracking Number to explicitly retrieve.

vendorCodestring

The Code number for the vendor's orders to retrieve.

includeNullboolean

Specify 'true' to output null data elements.

Headers

authenticationtokenstring required

Secure token for API authentication

passwordstring required

Password for the Crunchtime Application User.

sitenamestring required

Crunchtime site identifier. (test or production)

useridstring required

"User ID for the Crunchtime Application User.

X-B3-TraceIdstring

Optional trace identifier for troubleshooting.

Response

Success

hasNextboolean

has Next

totalPagesinteger

Total Pages

Example response

{
  "confirmReceiptStandardDetails": [
    {
      "confirmReceiptStandardHeaderDetails": {
        "confirmReceiptDate": "06/28/2024",
        "confirmReceiptUser": "BRUSER",
        "locationCode": "000011",
        "purchaseOrderNumber": "vo-116197",
        "trackingNumber": "T20121014",
        "vendorCode": "BS-V3"
      }
    }
  ],
  "hasNext": true,
  "totalPages": 10
}