v1

latestOpenAPI 3.0.0Apache License Version 2.02026-07-24163274903.6 KB
Vendor Location Service

getVendorLocationByPage

Retrieve vendor location details by page number.

get/vendorlocation/v1/getVendorLocationByPage

Query parameters

activeFlagboolean

Retrieve active vendors (Y/N) - optional.

includeDetailsboolean

Retrieve all details (optional).

locationCodestring

The Code that identifies the Location in Crunchtime. (A request requires at least one of the following: vendorCode or locationCode.)

pageNumberinteger

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

vendorCodestring

Vendor code. (A request requires at least one of the following: vendorCode or locationCode.)

pageSizeinteger

Number of items to display per page.

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
totalPagesinteger

Example response

{
  "vendorLocationDetails": [
    {
      "scheduleOverrideRowList": [
        {
          "endDate": "10/01/2018",
          "locationCode": "000122",
          "name": "Christmas Day",
          "note": "Description",
          "oldStartDate": "10/01/2018",
          "orderByTimeFriday": "15:10",
          "orderByTimeMonday": "15:10",
          "orderByTimeSaturday": "15:10",
          "orderByTimeSunday": "15:10",
          "orderByTimeThursday": "15:10",
          "orderByTimeTuesday": "15:10",
          "orderByTimeWednesday": "15:10",
          "recordType": "A",
          "startDate": "10/01/2018"
        }
      ],
      "vendorLocationHeaderDetails": {
        "active": "Y",
        "childID": "001",
        "deleteFlag": "Y",
        "exportCode": "EXP001",
        "locationCode": "000122",
        "tradingPartnerID": "001",
        "vendorDistrictID": "001"
      },
      "vendorLocationOtherDetail": {
        "contactName": "Name",
        "contactPhone": "222-222-222",
        "contactTitle": "Title",
        "locationCode": "000122",
        "message": "Message",
        "notes": "Description"
      },
      "vendorLocationScheduleDetail": {
        "locationCode": "000122",
        "orderByTimeFriday": "15:10",
        "orderByTimeMonday": "15:10",
        "orderByTimeSaturday": "15:10",
        "orderByTimeSunday": "15:10",
        "orderByTimeThursday": "15:10",
        "orderByTimeTuesday": "15:10",
        "orderByTimeWednesday": "15:10"
      },
      "vendorLocationTransmissionDetail": {
        "accrualFlag": "Y",
        "allowSimpleReceiptFlag": "Y",
        "autoReconcileEinvoiceFlag": "Y",
        "allowVOFlag": "Y",
        "codFlag": "Y",
        "electronicInvoiceFlag": "Y",
        "enforceMinimums": "Y",
        "locationCode": "000122",
        "orderAlert": "High Priority",
        "orderVendorUnitofMeasure": "Unit1",
        "referenceNumber": "REF-001",
        "userName": "john_doe",
        "userPassword": "P@ssw0rd",
        "voEMail": "example@example.com",
        "voFax": "+1234567890",
        "voMode": "E-Mail PDF"
      }
    }
  ]
}