> ## Documentation Index > Fetch the complete documentation index at: https://docs.drop-hub.com/llms.txt > Use this file to discover all available pages before exploring further. # Read this merchant's sandbox readiness checklist ## OpenAPI ````yaml /openapi.yaml get /v2/external/sandbox/readiness openapi: 3.1.0 info: title: DropHub External API version: v2 description: >- DropHub API v2 for Merchant, shipping-company, shipment, and OAuth 2.0 integrations. contact: name: DropHub API Governance license: name: Proprietary servers: - url: https://api-test.drop-hub.com description: Sandbox deployment with isolated data and credentials. - url: https://api.drop-hub.com description: Production deployment; production credentials only. security: [] tags: - name: Authentication description: >- Authentication, sessions, the company a principal is, and merchant API credentials - name: External Price Estimates description: OAuth-scoped transient route-distance and tariff calculation - name: External Shipments description: OAuth-scoped Merchant shipment creation, lookup, and cancellation - name: External Tracking description: Merchant-authenticated and privacy-minimized public tracking projections - name: Sandbox description: >- Tenant-bound self-service fixture lifecycle, available only on the isolated sandbox deployment - name: Webhook Endpoints description: Merchant webhook subscriptions, lifecycle, and signing-secret rotation - name: Webhook Deliveries description: Durable webhook delivery history and replay paths: /v2/external/sandbox/readiness: get: tags: - Sandbox summary: Read this merchant's sandbox readiness checklist operationId: getExternalMerchantSandboxReadiness responses: '200': description: Tenant-bound readiness and routable fixture coordinates content: application/json: schema: $ref: '#/components/schemas/SandboxReadiness' '401': $ref: '#/components/responses/AuthenticationFailed' '403': $ref: '#/components/responses/AccessDenied' '404': $ref: '#/components/responses/ResourceNotFound' security: - webSessionCookie: [] - oauthClientCredentials: - shipments:write components: schemas: SandboxReadiness: type: object additionalProperties: false required: - generation - canCreateShipment - nextShipmentDispatchHeld - branchCode - pickupLocationCode - pickup - delivery - destinationCityCode - sandboxDriverPhone - prerequisites properties: generation: type: integer minimum: 1 canCreateShipment: type: boolean nextShipmentDispatchHeld: type: boolean description: >- True when the next sandbox shipment will remain before any driver offer; consumed atomically by that creation. branchCode: type: string const: SANDBOX_BRANCH pickupLocationCode: type: string const: SANDBOX_PICKUP pickup: $ref: '#/components/schemas/SandboxFixtureCoordinate' delivery: $ref: '#/components/schemas/SandboxFixtureCoordinate' destinationCityCode: type: string const: RUH description: Use this fixture city code in price-estimate and shipment requests. sandboxDriverPhone: type: string pattern: ^05[0-9]{8}$ description: >- Sandbox-only driver OTP identity used to progress the real canonical driver lifecycle. prerequisites: type: array items: $ref: '#/components/schemas/SandboxReadinessItem' SandboxFixtureCoordinate: type: object additionalProperties: false required: - latitude - longitude properties: latitude: $ref: '#/components/schemas/Latitude' longitude: $ref: '#/components/schemas/Longitude' SandboxReadinessItem: type: object additionalProperties: false required: - prerequisite - ready properties: prerequisite: type: string enum: - merchant - branch - pickupLocation - coverage - commercialTerms - eligibleCarrier - dispatchableDriver - freshCanonicalLocation - routingCoordinates ready: type: boolean Problem: type: object description: RFC 9457 Problem Details with stable DropHub extensions additionalProperties: true required: - type - title - status - code - timestamp - correlationId - requestId properties: type: type: string format: uri title: type: string maxLength: 128 status: type: integer format: int32 minimum: 400 maximum: 599 detail: type: string maxLength: 512 instance: type: string format: uri-reference code: type: string pattern: ^[A-Z][A-Z0-9_]{1,63}$ timestamp: type: string format: date-time correlationId: type: string format: uuid requestId: type: string format: uuid traceId: type: string pattern: ^[0-9a-f]{32}$ violations: type: array maxItems: 20 items: $ref: '#/components/schemas/Violation' example: 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 Latitude: type: number minimum: -90 maximum: 90 multipleOf: 0.000001 x-java-type: java.math.BigDecimal x-postgresql-type: numeric(9,6) x-unit: decimal-degrees Longitude: type: number minimum: -180 maximum: 180 multipleOf: 0.000001 x-java-type: java.math.BigDecimal x-postgresql-type: numeric(10,6) x-unit: decimal-degrees Violation: type: object additionalProperties: false required: - field - code - message properties: field: type: string maxLength: 128 code: type: string maxLength: 64 message: type: string maxLength: 256 responses: AuthenticationFailed: description: Authentication failed without account, token, or tenant enumeration. headers: WWW-Authenticate: $ref: '#/components/headers/WwwAuthenticate' content: application/problem+json: schema: $ref: '#/components/schemas/Problem' example: 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 AccessDenied: description: >- Access denied without exposing internal policy or resource ownership. The machine code is `ACCESS_DENIED`, except for two refusals that describe the caller's own session and are therefore safe to name: `ASSURANCE_REQUIRED`, when the caller holds the authority but the session has not proved a second factor, and `REAUTHENTICATION_REQUIRED`, when the session is no longer fresh enough for the operation. Both are answered by proving the session again and retrying — see `POST /v2/company-authentication/assurance-elevations`. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' ResourceNotFound: description: Resource not found; existence is hidden across authorization boundaries. content: application/problem+json: schema: $ref: '#/components/schemas/Problem' headers: WwwAuthenticate: description: Bearer challenge for an unauthenticated or invalid-token request. schema: type: string example: Bearer securitySchemes: webSessionCookie: type: apiKey in: cookie name: dh_at description: >- 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. oauthClientCredentials: type: oauth2 description: >- OAuth 2.0 client-credentials flow for external machine-to-machine integrations. flows: clientCredentials: tokenUrl: /oauth/token scopes: shipments:read: Read Merchant-owned shipments shipments:write: Create and cancel Merchant-owned shipments webhooks:manage: Manage Merchant webhook endpoints, delivery history, and replay ````