Extras

Simulate a delivery action in test enviroment only.

post

https://test.swooveapi.comhttps://live.swooveapi.com

/delivery/simulate-action

Note that the actions need to be triggered in this order

1. ASSIGNED

2. PICKUP

3. PICKEDUP

4. DROPOFF

5. DROPEDOFF

6. ENDED

Query parameters

app_keystringRequired

Body

application/json

delivery_codestringRequiredDefault: The delivery code from the delivery that you want to simulate the action for. The delivery should already be created for this to happen

simulate_statusstring · enumRequired

• PENDING - The initial state of a delivery after creation - GROUPED - The delivery has been added to a group/trip - AGENCY_ASSIGNED - The delivery has been assigned to an agency - ASSIGNED - The delivery has been assigned to a rider - ONHOLD - The delivery is on hold due to low funds or some other reason - PICKUP - The rider is on the way to pick up the items - PICKEDUP - The rider has picked up the items - DROPOFF - The rider is on the way to drop off the items - DROPEDOFF - The rider has dropped off the items - ENDED - The delivery is commpleted - CANCELLED - The delivery has been cancelled

Possible values:

secret_codestringRequired

delivery secret code to be used in triggering ENDED status

Responses

200

Success Responses On Delivery Simulation

application/json

Responseall of

400

Validation Error

application/json

500

Simulate acction failed

post

/delivery/simulate-action

HTTPcURLJavaScriptPython

POST /delivery/simulate-action?app_key=text HTTP/1.1
Host: test.swooveapi.com
Content-Type: application/json
Accept: */*
Content-Length: 205

{
  "delivery_code": "The delivery code from the delivery that you want to simulate the action for. The delivery should already be created for this to happen",
  "simulate_status": "ASSIGNED",
  "secret_code": "text"
}

{
  "success": true,
  "code": 200,
  "message": "text",
  "responses": "text"
}