Keep the next sandbox shipment before the driver-offer boundary

curl --request POST \
  --url https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds \
  --cookie dh_at=

const options = {method: 'POST', headers: {cookie: 'dh_at='}};

fetch('https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_COOKIE => "dh_at=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("cookie", "dh_at=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["cookie"] = 'dh_at='

response = http.request(request)
puts response.read_body

{
  "generation": 2,
  "canCreateShipment": true,
  "nextShipmentDispatchHeld": true,
  "branchCode": "SANDBOX_BRANCH",
  "pickupLocationCode": "SANDBOX_PICKUP",
  "pickup": {
    "latitude": 0,
    "longitude": 0
  },
  "delivery": {
    "latitude": 0,
    "longitude": 0
  },
  "destinationCityCode": "RUH",
  "sandboxDriverPhone": "<string>",
  "prerequisites": [
    {
      "prerequisite": "merchant",
      "ready": true
    }
  ]
}

{
  "type": "https://api.drop-hub.com/problems/authentication-required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Authentication is required for this resource.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "AUTHENTICATION_REQUIRED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

POST

external

sandbox

dispatch-holds

Keep the next sandbox shipment before the driver-offer boundary

curl --request POST \
  --url https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds \
  --cookie dh_at=

const options = {method: 'POST', headers: {cookie: 'dh_at='}};

fetch('https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_COOKIE => "dh_at=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("cookie", "dh_at=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-test.drop-hub.com/v2/external/sandbox/dispatch-holds")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["cookie"] = 'dh_at='

response = http.request(request)
puts response.read_body

{
  "generation": 2,
  "canCreateShipment": true,
  "nextShipmentDispatchHeld": true,
  "branchCode": "SANDBOX_BRANCH",
  "pickupLocationCode": "SANDBOX_PICKUP",
  "pickup": {
    "latitude": 0,
    "longitude": 0
  },
  "delivery": {
    "latitude": 0,
    "longitude": 0
  },
  "destinationCityCode": "RUH",
  "sandboxDriverPhone": "<string>",
  "prerequisites": [
    {
      "prerequisite": "merchant",
      "ready": true
    }
  ]
}

{
  "type": "https://api.drop-hub.com/problems/authentication-required",
  "title": "Authentication required",
  "status": 401,
  "detail": "Authentication is required for this resource.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "AUTHENTICATION_REQUIRED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

{
  "type": "https://api.drop-hub.com/problems/access-denied",
  "title": "Access denied",
  "status": 403,
  "detail": "Access to this resource is denied.",
  "instance": "/v2/external/shipments/018f2d8a-1f00-7000-8000-000000000206",
  "code": "ACCESS_DENIED",
  "timestamp": "2026-08-22T18:30:00Z",
  "correlationId": "018f2d8a-1f00-7000-8000-000000000207",
  "requestId": "018f2d8a-1f00-7000-8000-000000000208"
}

Authorizations

dh_at

string

required

Opaque httpOnly browser session cookie issued by the existing human authentication flows. Browsers send it automatically; Swagger UI cannot and does not persist or manufacture it.

Response

Readiness with nextShipmentDispatchHeld set to true

generation

integer

required

Required range: x >= 1

canCreateShipment

boolean

required

nextShipmentDispatchHeld

boolean

required

True when the next sandbox shipment will remain before any driver offer; consumed atomically by that creation.

branchCode

string

required

Allowed value: "SANDBOX_BRANCH"

pickupLocationCode

string

required

Allowed value: "SANDBOX_PICKUP"

pickup

object

required

Show child attributes

delivery

object

required

Show child attributes

destinationCityCode

string

required

Use this fixture city code in price-estimate and shipment requests.

Allowed value: "RUH"

sandboxDriverPhone

string

required

Sandbox-only driver OTP identity used to progress the real canonical driver lifecycle.

Pattern: ^05[0-9]{8}$

prerequisites

object[]

required

Show child attributes

⌘I

Getting Started

Authentication

Shipments

Events

Request semantics

API reference

Keep the next sandbox shipment before the driver-offer boundary

Authorizations

Response