--- title: "getAllVendorLocation" method: GET path: "/cruise/vendorlocation/v1/getAllVendorLocation" tags: ["Vendor Location Service"] --- # getAllVendorLocation `GET /cruise/vendorlocation/v1/getAllVendorLocation` ## Request - Base URL: `//webservices-test.net-chef.com` (relative, and the document’s source URL is not known) - URL: `//webservices-test.net-chef.com/cruise/vendorlocation/v1/getAllVendorLocation` - Auth: none declared. Required headers: `authenticationtoken`, `password`, `sitename`, `userid` Retrieve vendor location details. ## Query parameters - `activeFlag` boolean - `includeDetails` boolean - `locationCode` string - `vendorCode` string - `includeNull` boolean ## Headers - `authenticationtoken` string, required - `password` string, required - `sitename` string, required - `userid` string, required - `X-B3-TraceId` string ## Response `200` Success - VendorLocationDetails[] - `scheduleOverrideRowList` VendorLocationScheduleOverrideDetails[] - `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` 'N' | 'Y': "orderDayFridayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayMondayFlag` 'N' | 'Y': "orderDayMondayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDaySaturdayFlag` 'N' | 'Y': "orderDaySaturdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDaySundayFlag` 'N' | 'Y': "orderDaySundayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayThursdayFlag` 'N' | 'Y': "orderDayThursdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayTuesdayFlag` 'N' | 'Y': "orderDayTuesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayWednesdayFlag` 'N' | 'Y': "orderDayWednesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `recordType` 'A/M/D', required: "recordType" - `startDate` string, required: "startDate" is Effective Start Date - `vendorCode` string, required: "vendorCode" from Vendors screen - `vendorLocationHeaderDetails` VendorLocationHeaderDto: VendorLocationHeaderDto description - `active` 'N' | 'Y': "active" - `childID` string: Child ID. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `deleteFlag` 'N' | 'Y': Delete flag - `exportCode` string: Export code. 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 - `tradingPartnerID` string: Trading partner ID. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `vendorCode` string, required: "vendorCode" from Vendors screen - `vendorDistrictID` string: Vendor district ID. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `vendorLocationOtherDetail` VendorLocationOtherDetailsDto: VendorLocationOtherDetailsDto description - `contactName` string: "contactName" from Vendor Information screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `contactPhone` string: "contactPhone" from Vendor Information screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `contactTitle` string: "contactTitle" from Vendor Information screen. 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 - `message` string: "message" from Vendor Information screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `notes` string: "notes" from Vendor Information screen. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `vendorCode` string, required: "vendorCode" from Vendors screen - `vendorLocationScheduleDetail` VendorLocationScheduleDetailDto: VendorLocationScheduleDetailDto description - `deliverDayFriday` string: "deliverDayFriday" is delivery day for Wednesday. 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 Wednesday. 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 Wednesday. 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 Wednesday. 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 Wednesday. 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 Wednesday. 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 Wednesday. 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 - `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` 'N' | 'Y': "orderDayFridayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayMondayFlag` 'N' | 'Y': "orderDayMondayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDaySaturdayFlag` 'N' | 'Y': "orderDaySaturdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDaySundayFlag` 'N' | 'Y': "orderDaySundayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayThursdayFlag` 'N' | 'Y': "orderDayThursdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayTuesdayFlag` 'N' | 'Y': "orderDayTuesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderDayWednesdayFlag` 'N' | 'Y': "orderDayWednesdayFlag". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `vendorCode` string, required: "vendorCode" from Vendors screen - `vendorLocationTransmissionDetail` VendorLocationTransmissionDetailDto: VendorLocationTransmissionDetailDto description - `accountNumber` string: "Account Number" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `accrualFlag` 'N' | 'Y': "Accrual" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `allowSimpleReceiptFlag` 'N' | 'Y': "Allow SR" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `autoReconcileEinvoiceFlag` 'N' | 'Y': "Auto-Reconcile" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `allowVOFlag` 'N' | 'Y': "Allow VO" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `codFlag` 'N' | 'Y': "COD" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `electronicInvoiceFlag` 'N' | 'Y': "E.Invoice" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `enforceMinimums` 'N' | 'Y': "Enforce Minimums" flag from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `locationCode` string, required: Location "Code" from Company setup screen. - `minimumCases` string: "Min. # of Cases" from Vendor Location Details. - `minimumValue` string: "Min. Value" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderAlert` string: "Order Alert" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `orderVendorUnitofMeasure` string: "Order V. OUM" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `referenceNumber` string: "Reference Number" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `userName` string: "User Name" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `userPassword` string: "Password" from Vendor Location Details. If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `vendorCode` string, required: Vendor "Code" from Vendors setup screen. - `voEMail` string: "VO Email". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `voFax` string: "VO Fax". If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. - `voMode` 'E-Mail Excel' | 'E-Mail PDF' | 'E-Mail PDF - Custom' | 'E-Mail Text' | 'FTP' | 'Fax' | 'Phone' | 'Secure FTP' | 'Web Services': "VO Mode" If the field value is null, the previously saved value will remain. To erase it, please enter '#DELETE' value. ## Other responses - `400`: Validation Error - `401`: Authorization - `404`: Vendor Location Not Found - `429`: Too Many Requests - `500`: Unexpected Error - `503`: System under maintenance - `504`: Timeout --- [API](https://skmtc.dev/crunchtime/apis/cruise-platform.md) - [All operations](https://skmtc.dev/crunchtime/apis/cruise-platform/llms.txt) - [OpenAPI document](https://skmtc.dev/crunchtime/apis/cruise-platform/revisions/d6bb0437a907?raw)