v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Customer Order Enhanced Service

getAllCustomerOrderEnhanced

Retrieves all customer orders with the accompanying information.

get/customerorderenhanced/v1/getAllCustomerOrderEnhanced

Query parameters

cateringOrderFlagboolean

Retrieve orders with Catering Order Flag enabled (Y/N) - optional.

customerCodestring

Code number for the Customer to retrieve. Required if Order Number or Order Date inputs not provided.

daypartCodeinteger

Code number for the Daypart to retrieve (optional).

expectedDeliveryDatestring

Expected Delivery Date (DD-MMM-YY) for orders to retrieve (optional).

includeDetailsboolean

Use true to retrieve detailed information for one Customer Order at a time (optional). When true, orderNumber must be used.

invoiceDatestring

Invoice Date (DD-MMM-YY) for orders to retrieve (optional).

locationCodestring required

The Code that identifies the Location in Crunchtime.

orderDatestring

Order Date (DD-MMM-YY) for orders to retrieve. Required if Order Number or Customer Code inputs not provided.

orderNumberstring

Order Number for order to retrieve. Required if Customer Code or Order Date inputs not provided.

orderStatus'SUBMITTED' | '18' | 'PICKLISTED' | '19' | 'INVOICED' | '2' | 'CANCELED' | '4' | 'FINALRECONCILED' | '3'

Order Status (SUBMITTED [18], PICKLISTED [19], INVOICED [2], CANCELED [4], FINAL RECONCILED [3]) for orders to retrieve (optional).

postDatestring

Post Date (DD-MMM-YY) for orders to retrieve (optional).

referenceNumberstring

Reference Number for order to retrieve (optional).

revenueCenterstring

Revenue Center for transactions to retrieve (optional).

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

Example response

[
  {
    "customerOrderEnhancedDetailDetails": [
      {
        "fillQuantity": 9999.9999,
        "finalReconcileQuantity": 9999.9999,
        "inventoryPrice": 0.37172525,
        "invoiceQuantity": 9999.9999,
        "orderQuantity": 1,
        "productNumber": "PRD-53275742",
        "storageLocationCode": "006",
        "unitPrice": 9999.9999,
        "storageLocationName": "BEER COOLER"
      }
    ],
    "customerOrderEnhancedHeaderDetails": {
      "cateringOrder": "N",
      "customerCode": "001",
      "customerName": "BS Loc 1 50% Markup",
      "dailyPrepDate": "06/30/2021",
      "dailyPrepDescription": "Markup",
      "daypartCode": 1,
      "daypartDescription": "BREAKFAST",
      "entryUser": "BSUSER1",
      "expectedDeliveryDate": "05/04/2019",
      "finalReconcileDate": "06/30/2021",
      "finalReconcileUser": "BSUSER1",
      "invoiceDate": "06/30/2021",
      "invoiceUser": "BSUSER1",
      "locationCode": "000000",
      "locationName": "(BS)-QA Loc One",
      "orderDate": "06/30/2021",
      "orderNumber": "PROD",
      "orderStatus": "INVOICED",
      "postDate": "06/30/2021",
      "revenueCenterDescription": "BAR"
    }
  }
]