{"openapi":"3.0.0","info":{"version":"1.0.0","title":"Fulflld API","description":"Welcome to the public api documentation"},"servers":[{"url":"https://api.fulflld.com"}],"components":{"schemas":{"TOKEN":{"type":"object","properties":{"token":{"type":"string","description":"Authorization token"}}},"BadRequestErr":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code","example":400},"code":{"type":"string","description":"Error code","example":"VALIDATION_ERR"},"message":{"type":"string","description":"Error details"}}},"UnauthorizedErr":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code","example":401},"code":{"type":"string","description":"Error code","example":"UNAUTHORIZED_ERROR"},"message":{"type":"string","description":"Error details"}}},"NotFoundErr":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code","example":404},"code":{"type":"string","description":"Error code","example":"NOT_FOUND_ERROR"},"message":{"type":"string","description":"Error details"}}},"CREATE_TOKEN":{"type":"object","properties":{"app_id":{"type":"string","description":"Unique app ID","example":"1a95544f-5e9b-458b-9dbc-eb89bcfbe10e"},"app_secret":{"type":"string","description":"App secret","example":"81bdcf2b-3b6f-4370-b13f-a350ff26b5bc"}},"required":["app_id","app_secret"]},"RequestForbiddenErr":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code","example":403},"code":{"type":"string","description":"Error code","example":"REQUEST_FORBIDDEN_ERROR"},"message":{"type":"string","description":"Error details"}}},"InternalServerErr":{"type":"object","properties":{"statusCode":{"type":"number","description":"HTTP Status Code","example":500},"code":{"type":"string","description":"Error code","example":"INTERNAL_SERVER_ERROR"},"message":{"type":"string","description":"Error details","example":"Couldn't create order"}}},"CreateOrder":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"required":["total","itemCount","description","tip","serviceTime"]},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the pickup location"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"required":["address","phone","location","scheduledPickupAt"]},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the dropoff location"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"required":["address","phone","location","scheduledDropoffAt"]},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"required":["signature","photo","notes"]}},"required":["orderId","order"]},"CreatePickupOnlyOrder":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"required":["total","itemCount","description","tip","serviceTime"]},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the pickup location"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"required":["address","phone","location","scheduledPickupAt","schedulePickupBeforeAt"]},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"required":["signature","photo","notes"]}},"required":["orderId","order","pickupDetails"]},"CreateDropoffOnlyOrder":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"required":["total","itemCount","description","tip","serviceTime"]},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the dropoff location"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"required":["address","phone","location","scheduledDropoffAt","scheduleDropoffAfterAt"]},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"required":["signature","photo","notes"]}},"required":["orderId","order","dropoffDetails"]},"UpdateOrder":{"type":"object","properties":{"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"status":{"type":"string","enum":["COMPLETE","FAILED","CANCELLED"],"description":"Desired status of the order","example":"COMPLETE"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}}},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the pickup location"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}}},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"required":["latitude","longitude"],"description":"lat lng value for the dropoff location"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}}},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}}}}}},"parameters":{}},"paths":{"/v1/auth/token":{"post":{"summary":"Generate authorization token","tags":["Auth"],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CREATE_TOKEN"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TOKEN"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedErr"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundErr"}}}}}}},"/v1/drivers/{id}":{"get":{"summary":"Get driver information","tags":["Driver"],"parameters":[{"schema":{"type":"string","description":"User ID of the driver","example":"6749a4efe571edb6e7ab4823"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"Driver name","example":"Shohidul Bari"},"phoneNumber":{"type":"string","description":"Driver contact number","example":"2038644450"},"licenseNumber":{"type":"string","description":"Driver license number","example":"LSN-2024"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/orders":{"post":{"summary":"Create Order","description":"For point-to-point deliveries, provide both pickupDetails and dropoffDetails. For pickup only orders, provide pickupDetails only. For dropoff only orders, provide dropoffDetails only.","tags":["Order"],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrder"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"description":"Pickup details of the order"},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"description":"Dropoff details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}},"get":{"summary":"Filter order","tags":["Order"],"parameters":[{"schema":{"type":"string","enum":["start-date","end-date"],"description":"Filter based on"},"required":true,"name":"filter","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Start datetime of the filter window"},"required":true,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time","description":"End datetime of the filter window. If not provided, It will be auto calculated by adding 3 days with the start timestamp"},"required":false,"name":"to","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"description":"Pickup details of the order"},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"description":"Dropoff details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/orders/pickup":{"post":{"summary":"Create pickup only order","tags":["Order"],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePickupOnlyOrder"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"description":"Pickup details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/orders/dropoff":{"post":{"summary":"Create dropoff only order","tags":["Order"],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDropoffOnlyOrder"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"description":"Dropoff details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/orders/{id}":{"get":{"summary":"Get order","tags":["Order"],"parameters":[{"schema":{"type":"string","description":"Given order ID during order creation","example":"6741c676f601c63879637714"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"description":"Pickup details of the order"},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"description":"Dropoff details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/orders/{id}/{internalId}":{"patch":{"summary":"Update order","tags":["Order"],"parameters":[{"schema":{"type":"string","description":"Given orderId during order creation","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d27294"},"required":true,"name":"internalId","in":"path"}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrder"}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"orderId":{"type":"string","description":"An unique ID to identify order in your system","example":"8b9f138e-4600-43cd-8659-f823799b1983"},"externalId":{"type":"string","description":"A unique friendly ID that is displayed in the Order Card for easy identification for the user","example":"SWT-1001"},"order":{"type":"object","properties":{"total":{"type":"number","description":"Total value for the order","example":100},"itemCount":{"type":"integer","description":"Number of distict number","example":2},"description":{"type":"string","description":"The details of your order for reference","example":"Order description"},"metadata":{"type":"string","description":"Metadata of your order","example":"Order metadata"},"tip":{"type":"number","description":"Tip for the driver","example":10},"serviceTime":{"type":"integer","description":"Service time for the order","example":9}},"description":"Order details"},"pickupDetails":{"type":"object","properties":{"name":{"type":"string","description":"Pickup name","example":"John Paul"},"businessName":{"type":"string","description":"Pickup business name","example":"Paul Catering"},"address":{"type":"string","description":"Full address for pickup","example":"501 Stanyan St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Pickup instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Pickup contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledPickupAt":{"type":"string","format":"date-time","description":"Scheduled pickup datetime in utc format","example":"2024-12-01T15:15:22Z"},"schedulePickupBeforeAt":{"type":"string","format":"date-time","description":"This field is required for pickup-only orders; this is the scheduled pickup before time","example":"2024-12-01T15:15:22Z"}},"description":"Pickup details of the order"},"dropoffDetails":{"type":"object","properties":{"name":{"type":"string","description":"Dropoff name","example":"Sumaiya Akter"},"businessName":{"type":"string","description":"Dropoff name","example":"United medical ltd."},"address":{"type":"string","description":"Dropoff address","example":"710 Steiner St, San Francisco, CA 94117"},"instructions":{"type":"string","description":"Dropoff instruction for driver","example":"Call me!"},"phone":{"type":"string","description":"Dropoff contact number","example":"1415555267"},"location":{"type":"object","properties":{"latitude":{"type":"number","description":"Location latitude","example":37.7763},"longitude":{"type":"number","description":"Location longitude","example":-122.4327}},"description":"Location Details"},"scheduledDropoffAt":{"type":"string","format":"date-time","description":"Scheduled dropoff datatime in utc format","example":"2024-12-01T15:15:22Z"},"scheduleDropoffAfterAt":{"type":"string","format":"date-time","description":"This field is required for dropoff-only orders; this is the scheduled dropoff after time","example":"2024-12-01T15:15:22Z"}},"description":"Dropoff details of the order"},"deliveryRequirements":{"type":"object","properties":{"signature":{"type":"boolean","description":"Is signature required for delivery?","example":true},"photo":{"type":"boolean","description":"Is photo required for delivery?","example":true},"notes":{"type":"boolean","description":"Is notes required for delivery?","example":true}},"description":"Order completion requirements for the driver"},"internalId":{"type":"string","description":"Unique identifier of your order. This is used when executing other operations such as update","example":"674999088ecba46da4d8234"},"assigneeId":{"type":"string","description":"Assigned driver ID if available","example":"674999088ecba46da4d176523"},"status":{"type":"string","enum":["TODO","INPROGRESS","COMPLETE","FAILED","CANCELLED"],"description":"Status of the order","example":"COMPLETE"},"statusDetails":{"type":"object","properties":{"pickupInTransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to pickup location"},"pickupArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the pickup location"},"pickupCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The Timestamp when the driver has picked up the order from the pickup location"},"dropoffIntransit":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver is in transit to dropoff location"},"dropoffArrived":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has arrived the dropoff location"},"dropoffCompleted":{"type":"string","nullable":true,"format":"date-time","description":"The timestamp when the driver has dropped off the order at the dropoff location"}},"description":"Timestamps for each progress of an order"},"eta":{"type":"string","nullable":true,"format":"date-time","description":"ETA for the driver to reach the dropoff location"},"attachments":{"type":"array","items":{"type":"object","properties":{"url":{"type":"string","description":"The link of the attachment"},"type":{"type":"string","enum":["SIGNATURE","POD_IMAGE","AVATAR","DOC"],"description":"Type of the attachement"}}},"description":"Attachments present for the order. This may consist of proof of deliveries, signatures, etc"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/route":{"post":{"summary":"Create Route","tags":["Route"],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"orderIds":{"type":"array","items":{"type":"string"},"description":"List of order Ids","example":["xyz-1","xyz-2"]},"assigneeId":{"type":"string","description":"Assignee ID for this route","example":"674999088ecba46da4d27294"}},"required":["orderIds"]}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Route id","example":"674999088ecba46da4d27294"},"assigneeId":{"type":"string","nullable":true,"description":"Route assignee ID","example":"674999088ecba46da4d27294"},"ordersSequence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Order ID","example":"xyz-1"},"type":{"type":"string","example":"order"},"index":{"type":"number","description":"Order sequence index","example":1}}}},"scheduledDate":{"type":"string","format":"date-time","description":"Route scheduled timestamp","example":"2024-12-01T14:15:22Z"},"createdAt":{"type":"string","format":"date-time","description":"Route creation timestamp","example":"2024-12-01T14:15:22Z"},"status":{"type":"string","enum":["COMPLETE","INCOMPLETE"],"description":"Status of the route","example":"COMPLETE"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}},"get":{"summary":"Filter Route","tags":["Route"],"parameters":[{"schema":{"type":"string","enum":["scheduled-date"],"description":"Filter based on"},"required":true,"name":"filter","in":"query"},{"schema":{"type":"string","format":"date-time","description":"Start datetime of the filter window","example":"2024-12-01T13:12:23.683Z"},"required":true,"name":"from","in":"query"},{"schema":{"type":"string","format":"date-time","description":"End datetime of the filter window. If not provided, It will be auto calculated by adding 3 days with the start timestamp","example":"2024-12-03T13:12:23.683Z"},"required":false,"name":"to","in":"query"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Route id","example":"674999088ecba46da4d27294"},"assigneeId":{"type":"string","nullable":true,"description":"Route assignee ID","example":"674999088ecba46da4d27294"},"ordersSequence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Order ID","example":"xyz-1"},"type":{"type":"string","example":"order"},"index":{"type":"number","description":"Order sequence index","example":1}}}},"scheduledDate":{"type":"string","format":"date-time","description":"Route scheduled timestamp","example":"2024-12-01T14:15:22Z"},"createdAt":{"type":"string","format":"date-time","description":"Route creation timestamp","example":"2024-12-01T14:15:22Z"},"status":{"type":"string","enum":["COMPLETE","INCOMPLETE"],"description":"Status of the route","example":"COMPLETE"}}},"description":"List of routes in a given date range"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}},"/v1/route/{id}":{"patch":{"summary":"Update Route","tags":["Route"],"parameters":[{"schema":{"type":"string","description":"Route Id","example":"674999088ecba46da4d27294"},"required":true,"name":"id","in":"path"}],"requestBody":{"description":"Request body","content":{"application/json":{"schema":{"type":"object","properties":{"ordersSequence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Order Id","example":"xyz-1"},"type":{"type":"string","example":"order"},"index":{"type":"number","description":"desired index for reordering","example":1}},"required":["id","type","index"]}},"assigneeId":{"type":"string"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Route id","example":"674999088ecba46da4d27294"},"assigneeId":{"type":"string","nullable":true,"description":"Route assignee ID","example":"674999088ecba46da4d27294"},"ordersSequence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Order ID","example":"xyz-1"},"type":{"type":"string","example":"order"},"index":{"type":"number","description":"Order sequence index","example":1}}}},"scheduledDate":{"type":"string","format":"date-time","description":"Route scheduled timestamp","example":"2024-12-01T14:15:22Z"},"createdAt":{"type":"string","format":"date-time","description":"Route creation timestamp","example":"2024-12-01T14:15:22Z"},"status":{"type":"string","enum":["COMPLETE","INCOMPLETE"],"description":"Status of the route","example":"COMPLETE"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}},"get":{"summary":"Get Route","tags":["Route"],"parameters":[{"schema":{"type":"string","description":"Route Id","example":"674999088ecba46da4d27294"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Route id","example":"674999088ecba46da4d27294"},"assigneeId":{"type":"string","nullable":true,"description":"Route assignee ID","example":"674999088ecba46da4d27294"},"ordersSequence":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","description":"Order ID","example":"xyz-1"},"type":{"type":"string","example":"order"},"index":{"type":"number","description":"Order sequence index","example":1}}}},"scheduledDate":{"type":"string","format":"date-time","description":"Route scheduled timestamp","example":"2024-12-01T14:15:22Z"},"createdAt":{"type":"string","format":"date-time","description":"Route creation timestamp","example":"2024-12-01T14:15:22Z"},"status":{"type":"string","enum":["COMPLETE","INCOMPLETE"],"description":"Status of the route","example":"COMPLETE"}}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BadRequestErr"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RequestForbiddenErr"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerErr"}}}}}}}}}