getVendorLocationByPage

Retrieve vendor location details by page number.

Log in to see full request history
Query Params
boolean

Retrieve active vendors (Y/N) - optional.

boolean

Retrieve all details (optional).

string
required

The Code that identifies the Location in Crunchtime.

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.

string

Vendor code.

int32

Number of items to display per page.

boolean

Specify 'true' to output null data elements.

Headers
string
required

Secure token for API authentication.

string
required

Password for the Crunchtime Application User.

string
required

Crunchtime site identifier. (test or production)

string
required

User ID for the Crunchtime Application User.

string

Optional trace identifier for troubleshooting.

Responses

Response body
object
boolean
int32
vendorLocationDetails
array of objects
vendorLocationDetails
object
scheduleOverrideRowList
array of objects
scheduleOverrideRowList
object
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.

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.

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.

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.

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.

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.

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.

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.

string
required

"locationCode" from Company setup screen

string
required

"name"

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.

string
required

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

string

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

N Y

string

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

N Y

string

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

N Y

string

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

N Y

string

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

N Y

string

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

N Y

string

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

N Y

string
required

"recordType"

A/M/D

string
required

"startDate" is Effective Start Date

string
required

"vendorCode" from Vendors screen

vendorLocationHeaderDetails
object

VendorLocationHeaderDto description

vendorLocationOtherDetail
object

VendorLocationOtherDetailsDto description

vendorLocationScheduleDetail
object

VendorLocationScheduleDetailDto description

vendorLocationTransmissionDetail
object

VendorLocationTransmissionDetailDto description

Language