> ## Documentation Index
> Fetch the complete documentation index at: https://developers.leadwaycrm.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List Shipping Rates

> The "List Shipping Rate" API allows to retrieve a list of shipping rate.

The "List Shipping Rate" API allows to retrieve a list of shipping rate.

```http theme={null}
GET https://services.leadconnectorhq.com/store/shipping-zone/{shippingZoneId}/shipping-rate
```

## Autorización

<ParamField header="Authorization" type="string" required>
  Bearer token generado desde el portal Leadway. Ver [Autenticación](/authentication).
</ParamField>

<ParamField header="Version" type="string" required default="2021-07-28">
  Versión de la API.
</ParamField>

## Path parameters

<ParamField path="shippingZoneId" type="string" required default="6578278e879ad2646715ba9c">
  ID of the item that needs to be returned
</ParamField>

## Query parameters

<ParamField query="altId" type="string" required default="6578278e879ad2646715ba9c">
  Account Id or Agency Id
</ParamField>

<ParamField query="altType" type="string" required />

<ParamField query="limit" type="number" default="20">
  The maximum number of items to be included in a single page of results
</ParamField>

<ParamField query="offset" type="number" default="0">
  The starting index of the page, indicating the position from which the results should be retrieved.
</ParamField>

## Respuestas

<Accordion title="200 - Successful response">
  <ResponseField name="total" type="number" required default="20">
    Total number of items
  </ResponseField>

  <ResponseField name="data" type="object[]" required>
    An array of items

    <Expandable title="cada item">
      <ResponseField name="altId" type="string" required default="6578278e879ad2646715ba9c">
        Account Id or Agency Id
      </ResponseField>

      <ResponseField name="altType" type="string" required>
        Posibles valores: 'account'
      </ResponseField>

      <ResponseField name="name" type="string" required default="North zone">
        Name of the shipping zone
      </ResponseField>

      <ResponseField name="description" type="string" default="Ships next day">
        Delivery description
      </ResponseField>

      <ResponseField name="currency" type="string" required default="USD">
        The currency of the amount of the rate / handling fee
      </ResponseField>

      <ResponseField name="amount" type="number" required default="99.99">
        The amount of the shipping rate if it is normal rate (0 means free ). Fixed Handling fee if it is a carrier rate (it will add to the carrier rate).
      </ResponseField>

      <ResponseField name="conditionType" type="string" required default="price">
        Type of condition to provide the conditional pricing Posibles valores: 'none', 'price', 'weight'
      </ResponseField>

      <ResponseField name="minCondition" type="number" required default="99.99">
        Minimum condition for applying this price. set 0 or null if there is no minimum
      </ResponseField>

      <ResponseField name="maxCondition" type="number" required default="99.99">
        Maximum condition for applying this price. set 0 or null if there is no maximum
      </ResponseField>

      <ResponseField name="isCarrierRate" type="boolean" default="True">
        is this a carrier rate
      </ResponseField>

      <ResponseField name="shippingCarrierId" type="string" required default="655b33a82209e60b6adb87a5">
        Shipping carrier id
      </ResponseField>

      <ResponseField name="percentageOfRateFee" type="number" default="10.99">
        Percentage of rate fee if it is a carrier rate.
      </ResponseField>

      <ResponseField name="shippingCarrierServices" type="object[]">
        An array of items

        <Expandable title="cada item">
          <ResponseField name="name" type="string" required default="Priority Mail Express International">
            Name of the shipping carrier service
          </ResponseField>

          <ResponseField name="value" type="string" required default="PriorityMailExpressInternational">
            Value of the shipping carrier service
          </ResponseField>
        </Expandable>
      </ResponseField>

      <ResponseField name="_id" type="string" required default="655b33a82209e60b6adb87a5">
        The unique identifier for the product.
      </ResponseField>

      <ResponseField name="shippingZoneId" type="string" required default="655b33a82209e60b6adb87a5">
        The unique identifier for the shipping zone.
      </ResponseField>

      <ResponseField name="createdAt" type="string" required default="2023-12-12T09:27:42.355Z">
        created at
      </ResponseField>

      <ResponseField name="updatedAt" type="string" required default="2023-12-12T09:27:42.355Z">
        updated at
      </ResponseField>
    </Expandable>
  </ResponseField>

  ```json theme={null}
  {
    "total": 20,
    "data": [
      {
        "altId": "6578278e879ad2646715ba9c",
        "altType": "account",
        "name": "North zone",
        "description": "Ships next day",
        "currency": "USD",
        "amount": 99.99,
        "conditionType": "price",
        "minCondition": 99.99,
        "maxCondition": 99.99,
        "isCarrierRate": true,
        "shippingCarrierId": "655b33a82209e60b6adb87a5",
        "percentageOfRateFee": 10.99,
        "shippingCarrierServices": [
          {}
        ],
        "_id": "655b33a82209e60b6adb87a5",
        "shippingZoneId": "655b33a82209e60b6adb87a5",
        "createdAt": "2023-12-12T09:27:42.355Z",
        "updatedAt": "2023-12-12T09:27:42.355Z"
      }
    ]
  }
  ```
</Accordion>

<Accordion title="400 - Bad Request">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="401 - Unauthorized">
  ```json theme={null}
  {}
  ```
</Accordion>

<Accordion title="422 - Unprocessable Entity">
  ```json theme={null}
  {}
  ```
</Accordion>

## Ejemplo

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET 'https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate' \
    -H 'Authorization: Bearer YOUR_TOKEN' \
    -H 'Version: 2021-07-28'
  ```

  ```javascript Node.js theme={null}
  const response = await fetch('https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate', {
    method: 'GET',
    headers: {
      Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
      Version: '2021-07-28',
    },
  });
  const data = await response.json();
  ```

  ```python Python theme={null}
  import os, requests
  response = requests.request(
      'GET',
      'https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate',
      headers={
          'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
          'Version': '2021-07-28',
      },
  )
  data = response.json()
  ```

  ```php PHP theme={null}
  <?php
  $ch = curl_init('https://services.leadconnectorhq.com/store/shipping-zone/YOUR_shippingZoneId/shipping-rate');
  curl_setopt_array($ch, [
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_CUSTOMREQUEST => 'GET',
      CURLOPT_HTTPHEADER => [
          'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
          'Version: 2021-07-28',
      ],
  ]);
  $data = json_decode(curl_exec($ch), true);
  ```
</CodeGroup>