List Warehouses

Retrieve available warehouses with pagination support, ordered by I2 code ascending. Returns comprehensive warehouse information including location details, address, postal information, coordinates, geofences, and service window configuration rules.

Service Windows: Each warehouse includes an array of service window configuration rules that define operational time slots for truck loading/unloading. These windows specify:

Time Ranges: Windows can have one or two time slots per day (e.g., morning 8:00-12:00 and afternoon 14:00-17:00)

Recurring Schedule: Define which days of the week the window is active (monday-sunday)

Operation Types: Specify supported business operations (e.g., Traditional distribution, Modern trade, Exports, Dealerships)

Vehicle Constraints: Filter by fleet type (Full, Sencillo, Thorton) and vehicle type (Dry box, Curtain-sided)

Capacity Configuration: Define total capacity limits and additional constraints for dry box and dedicated fleet trucks

Service Time: Expected time in hours to service each truck (e.g., 0.5 for 30 minutes)

Parallel Processing: Number of trucks that can be serviced simultaneously (parallelSlotCapacity)

Slot Management: Total number of service slots available within the window (totalSlots)

Validity Period: Windows include validFromDate and validToDate to manage temporal configurations

Clients can use this information to understand warehouse operational capabilities and plan shipments based on operation type, vehicle requirements, and time slot availability. Note: This endpoint provides window configuration data only; for real-time availability checking, use the dedicated availability endpoints.

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

{"message":"Warehouses retrieved successfully","data":{"warehouses":[{"_id":"507f1f77bcf86cd799439018","I2Code":"2070603000","sapCode":"WH001","name":"MAIN DISTRIBUTION CENTER","countryName":"Mexico","stateCode":"MX","stateName":"Mexico","municipalityCode":"015","municipalityName":"Ecatepec de Morelos","localityCode":"0001","localityName":"Ecatepec de Morelos","colonyCode":"0001","colonyName":"Centro","postalCode":"55000","address":"Av. Central 123","street":"Av. Central","externalNumber":"123","internalNumber":"A","lng":-99.0608,"lat":19.6073,"geofences":[{"_id":"507f1f77bcf86cd799439020","name":"Main Entrance","type":"entry","points":[{"lng":-99.0608,"lat":19.6073},{"lng":-99.061,"lat":19.6075}]}],"windows":[{"_id":"507f1f77bcf86cd799439022","operationType":[{"operationTypeCode":"TP04","operationTypeName":"Tradicional"},{"operationTypeCode":"TP01","operationTypeName":"Moderno"}],"firstWindowStartTime":"08:00","firstWindowEndTime":"12:00","firstWindowTime":"08:00-12:00","secondWindowStartTime":"14:00","secondWindowEndTime":"17:00","secondWindowTime":"14:00-17:00","serviceTimeHr":0.5,"weekDays":["monday","tuesday","wednesday","thursday","friday"],"fleetTypes":["Full","Sencillo"],"vehicleTypes":["Caja seca","Encortinado"],"totalCapacity":10,"dryBoxCapacity":5,"dedicatedCapacity":3,"parallelSlotCapacity":2,"totalSlots":8,"validFromDate":"2024-01-01T00:00:00.000Z","validToDate":null,"transportCompanies":[{"companyId":"6902240558ede69a6099ac11","name":"TRANSER","code":"00404033"},{"companyId":"6902246958ede69a6099ac19","name":"ADP SA","code":"00411212"}]}]},{"_id":"507f1f77bcf86cd799439019","I2Code":"2070603001","sapCode":"WH002","name":"REGIONAL WAREHOUSE NORTH","countryName":"Mexico","stateCode":"MX","stateName":"Mexico","municipalityCode":"020","municipalityName":"Tlalnepantla de Baz","localityCode":"0001","localityName":"Tlalnepantla de Baz","colonyCode":"0010","colonyName":"Industrial","postalCode":"54030","address":"Blvd. Industrial 456","street":"Blvd. Industrial","externalNumber":"456","internalNumber":"B","lng":-99.195,"lat":19.5389,"geofences":[{"_id":"507f1f77bcf86cd799439024","name":"Service Gate","type":"service","points":[{"lng":-99.195,"lat":19.5389},{"lng":-99.1955,"lat":19.5392}]}],"windows":[{"_id":"507f1f77bcf86cd799439025","operationType":[{"operationTypeCode":"TP11","operationTypeName":"Exportación"}],"firstWindowStartTime":"07:00","firstWindowEndTime":"19:00","firstWindowTime":"07:00-19:00","secondWindowStartTime":null,"secondWindowEndTime":null,"secondWindowTime":null,"serviceTimeHr":1,"weekDays":["monday","tuesday","wednesday","thursday","friday"],"fleetTypes":["Full"],"vehicleTypes":["Encortinado"],"totalCapacity":12,"dryBoxCapacity":null,"dedicatedCapacity":null,"parallelSlotCapacity":3,"totalSlots":12,"validFromDate":"2024-01-01T00:00:00.000Z","validToDate":null,"transportCompanies":[]}]}],"pagination":{"page":1,"size":20,"totalWarehouses":45,"totalPages":3,"hasNextPage":true,"hasPreviousPage":false}}}

Request

Responses