Jahzha
    Jahzha
    • Jahzha API Documentation
    • User Credentials
      POST
    • Create Order
      POST
    • Get Offers
      POST
    • Create Shipment
      POST
    • Get Shipment By ID
      GET

      Get Offers

      Developing
      POST
      https://company.jahzha.com.sa/api/v1/shipment-offers
      Shipment Offers Endpoint
      This endpoint allows API clients to retrieve available shipping offers from multiple shipping companies based on shipment details provided by the user.
      The API handles the full workflow internally:
      it validates shipment data, stores shipper and receiver addresses, creates a draft shipment, and then communicates with integrated shipping providers to calculate and return the best available offers.
      The response contains normalized shipping offers without exposing internal pricing calculations, making it safe and ready to be consumed directly by client applications (web, mobile, or third-party platforms).
      This endpoint is protected by API Key & Secret authentication and requires the user to have the appropriate API integration permissions.
      Typical use cases include:
      Comparing shipping prices across multiple carriers
      Displaying shipping options before checkout
      Powering external platforms (e.g. Shopify, custom stores, ERP systems) with real-time shipping offers

      Request

      Header Params

      Body Params multipart/form-data

      Responses

      🟠422Validation Error
      application/json
      Body

      🟠401unAutunauthorized
      🟢200Success
      Request Request Example
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'https://company.jahzha.com.sa/api/v1/shipment-offers' \
      --header 'Accept: application/json' \
      --header 'API-KEY: dc7b2b2435239448b4568dff5d7a6954d3abde42880439d3c300a0580766bc15a30c4a' \
      --header 'SECRET-KEY: sk_zB3WdSJeU8GeWgfoBae23yNf38R4543543MejiYXqkxCmxSMtWj' \
      --header 'Accept-Language: en' \
      --form 'box_count="2"' \
      --form 'weight="14"' \
      --form 'length="14"' \
      --form 'width="14"' \
      --form 'height="14"' \
      --form 'add_pickup="1"' \
      --form 'description="any cool description"' \
      --form 'cod_value="150"' \
      --form 'package_type="normal"' \
      --form 'shipper[name]="Mostafa"' \
      --form 'shipper[email]="example@email.com"' \
      --form 'shipper[phone_number]="511111111"' \
      --form 'shipper[city]="Jeddah"' \
      --form 'shipper[city_lat]="21.4858"' \
      --form 'shipper[city_lng]="21.4858"' \
      --form 'shipper[address]="SA, 13st, jeddah street"' \
      --form 'shipper[region_name]="Makkah Region"' \
      --form 'shipper[postal_code]="11111"' \
      --form 'shipper[short_address]="ABCD1234"' \
      --form 'receiver[name]="Fathy"' \
      --form 'receiver[email]="example@email.com"' \
      --form 'receiver[phone_number]="511111111"' \
      --form 'receiver[city]="Dammam"' \
      --form 'receiver[city_lat]="21.4858"' \
      --form 'receiver[city_lng]="21.4858"' \
      --form 'receiver[address]="Dammam street"' \
      --form 'receiver[region_name]="Eastern Province"' \
      --form 'receiver[postal_code]="55555"' \
      --form 'receiver[short_address]="ABCD1234"'
      Response Response Example
      422 - Validation Error
      {
          "status_code": 422,
          "message": "The selected Shipment type is invalid.",
          "data": [],
          "additional_data": []
      }
      Modified at 2026-01-25 22:32:54
      Previous
      Create Order
      Next
      Create Shipment
      Built with