getVendorLocationByPage

get https://webservices-test.net-chef.com/vendorlocation/v1/getVendorLocationByPage

Retrieve vendor location details by page number.

Query Params

activeFlag

boolean

Retrieve active vendors (Y/N) - optional.

includeDetails

boolean

Retrieve all details (optional).

locationCode

string

required

The Code that identifies the Location in Crunchtime.

pageNumber

int32

Defaults to 1

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

vendorCode

string

Vendor code.

pageSize

int32

Number of items to display per page.

includeNull

boolean

Specify 'true' to output null data elements.

Headers

authenticationtoken

string

required

Secure token for API authentication.

password

string

required

Password for the Crunchtime Application User.

sitename

string

required

Crunchtime site identifier. (test or production)

userid

string

required

User ID for the Crunchtime Application User.

X-B3-TraceId

string

Optional trace identifier for troubleshooting.

Responses

Response body

object

hasNext

boolean

totalPages

int32

vendorLocationDetails

array of objects

vendorLocationDetails

object

scheduleOverrideRowList

array of objects

scheduleOverrideRowList

object

deliverDayFriday

string

"deliverDayFriday" is delivery day for Friday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDayMonday

string

"deliverDayMonday" is delivery day for Monday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDaySaturday

string

"deliverDaySaturday" is delivery day for Saturday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDaySunday

string

"deliverDaySunday" is delivery day for Sunday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDayThursday

string

"deliverDayThursday" is delivery day for Sunday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDayTuesday

string

"deliverDayTuesday" is delivery day for Sunday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

deliverDayWednesday

string

"deliverDayWednesday" is delivery day for Sunday. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

endDate

string

required

"endDate" is Effective End Date. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

locationCode

string

required

"locationCode" from Company setup screen

name

string

required

"name"

note

string

"note" is Description related to Override. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

oldStartDate

string

required

"oldStartDate" is Start Date existing Schedule Override (it's necessary for determine an existing record).

orderByTimeFriday

string

"orderByTimeFriday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeMonday

string

"orderByTimeMonday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeSaturday

string

"orderByTimeSaturday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeSunday

string

"orderByTimeSunday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeThursday

string

"orderByTimeThursday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeTuesday

string

"orderByTimeTuesday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderByTimeWednesday

string

"orderByTimeWednesday". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

orderDayFridayFlag

string

"orderDayFridayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDayMondayFlag

string

"orderDayMondayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDaySaturdayFlag

string

"orderDaySaturdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDaySundayFlag

string

"orderDaySundayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDayThursdayFlag

string

"orderDayThursdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDayTuesdayFlag

string

"orderDayTuesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

orderDayWednesdayFlag

string

"orderDayWednesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value.

N Y

recordType

string

required

"recordType"

A/M/D

startDate

string

required

"startDate" is Effective Start Date

vendorCode

string

required

"vendorCode" from Vendors screen

vendorLocationHeaderDetails

object

VendorLocationHeaderDto description

vendorLocationOtherDetail

object

VendorLocationOtherDetailsDto description

vendorLocationScheduleDetail

object

VendorLocationScheduleDetailDto description

vendorLocationTransmissionDetail

object

VendorLocationTransmissionDetailDto description

Language


xxxxxxxxxx
1
curl --request GET \
2
     --url 'https://webservices-test.net-chef.com/vendorlocation/v1/getVendorLocationByPage?pageNumber=1' \
3
     --header 'accept: application/json'


xxxxxxxxxx
106
}
1
{
2
  "hasNext": true,
3
  "totalPages": 0,
4
  "vendorLocationDetails": [
5
    {
6
      "scheduleOverrideRowList": [
7
        {
8
          "deliverDayFriday": 1,
9
          "deliverDayMonday": 1,
10
          "deliverDaySaturday": 1,
11
          "deliverDaySunday": 1,
12
          "deliverDayThursday": 1,
13
          "deliverDayTuesday": 1,
14
          "deliverDayWednesday": 1,
15
          "endDate": "10/01/2018",
16
          "locationCode": "000122",
17
          "name": "Christmas Day",
18
          "note": "Description",
19
          "oldStartDate": "10/01/2018",
20
          "orderByTimeFriday": "15:10",
21
          "orderByTimeMonday": "15:10",
22
          "orderByTimeSaturday": "15:10",
23
          "orderByTimeSunday": "15:10",
24
          "orderByTimeThursday": "15:10",
25
          "orderByTimeTuesday": "15:10",

200Success

400Validation Error

401Authorization

404Vendor Location Not Found

500Unexpected Error

503System under maintenance

504Timeout