> ## 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.

# Calculate what this merchant is charged for a delivery

> Calculates authoritative route distance and returns the delivery price agreed with this merchant. DropHub internally verifies an eligible carrier and available driver; merchants never select or receive a carrier identifier. No calculation is persisted.



## OpenAPI

````yaml /openapi.yaml post /v2/external/shipment-price-estimates
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/shipment-price-estimates:
    post:
      tags:
        - External Price Estimates
      summary: Calculate what this merchant is charged for a delivery
      description: >-
        Calculates authoritative route distance and returns the delivery price
        agreed with this merchant. DropHub internally verifies an eligible
        carrier and available driver; merchants never select or receive a
        carrier identifier. No calculation is persisted.
      operationId: calculateExternalShipmentPrice
      parameters:
        - $ref: '#/components/parameters/AcceptLanguage'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ExternalShipmentPriceEstimateRequest'
      responses:
        '200':
          description: Current transient price estimate
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalShipmentPriceEstimate'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/AuthenticationFailed'
        '403':
          $ref: '#/components/responses/AccessDenied'
        '404':
          $ref: '#/components/responses/ResourceNotFound'
        '405':
          $ref: '#/components/responses/MethodNotAllowed'
        '422':
          $ref: '#/components/responses/ValidationFailed'
        '429':
          $ref: '#/components/responses/RateLimited'
        '503':
          $ref: '#/components/responses/ProviderUnavailable'
      security:
        - oauthClientCredentials:
            - shipments:write
components:
  parameters:
    AcceptLanguage:
      name: Accept-Language
      in: header
      required: false
      description: >-
        Preferred response language when a localized representation is
        available.
      schema:
        type: string
        maxLength: 64
        example: en
  schemas:
    ExternalShipmentPriceEstimateRequest:
      type: object
      additionalProperties: false
      required:
        - pickup
        - delivery
        - destinationCityCode
      properties:
        pickup:
          $ref: '#/components/schemas/Coordinate'
        delivery:
          $ref: '#/components/schemas/Coordinate'
        destinationCityCode:
          type: string
          pattern: ^[A-Z0-9_-]{2,32}$
      example:
        pickup:
          latitude: 24.7136
          longitude: 46.6753
        delivery:
          latitude: 24.774265
          longitude: 46.738586
        destinationCityCode: RUH
    ExternalShipmentPriceEstimate:
      type: object
      additionalProperties: false
      description: >-
        What this merchant will be charged for this delivery. DropHub's carrier
        decision and commercial margin are internal and deliberately absent.
      required:
        - distanceMetres
        - price
        - currency
      properties:
        distanceMetres:
          type: integer
          format: int64
          minimum: 1
        price:
          type: number
          format: decimal
          minimum: 0
          multipleOf: 0.01
          description: The delivery price currently agreed with this merchant.
        currency:
          type: string
          enum:
            - SAR
    Coordinate:
      type: object
      additionalProperties: false
      required:
        - latitude
        - longitude
      properties:
        latitude:
          $ref: '#/components/schemas/Latitude'
        longitude:
          $ref: '#/components/schemas/Longitude'
    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:
    BadRequest:
      description: >-
        The request syntax, path parameter, query parameter, or JSON document is
        malformed.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    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'
    MethodNotAllowed:
      description: The method is not supported for this resource.
      headers:
        Allow:
          description: Methods supported by this resource.
          schema:
            type: string
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ValidationFailed:
      description: The request fails strict syntax or semantic validation.
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    RateLimited:
      description: The security operation is temporarily rate limited.
      headers:
        Retry-After:
          description: Suggested delay in seconds when available.
          schema:
            type: integer
            minimum: 1
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/Problem'
    ProviderUnavailable:
      description: No qualified routing provider is configured; the operation fails closed.
      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:
    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

````