# CarrierService

        <p>A carrier service (also known as a carrier calculated service or shipping service) provides real-time shipping rates to Shopify. Some common carrier services include Canada Post, FedEx, UPS, and USPS. The term <strong>carrier</strong> is often used interchangeably with the terms <strong>shipping company</strong> and <strong>rate provider</strong>.</p>
        <p>Using the CarrierService resource, you can add a carrier service to a shop and then provide a list of applicable shipping rates at checkout. You can even use the cart data to adjust shipping rates and offer shipping discounts based on what is in the customer's cart.</p>
        <h2>Requirements for accessing the CarrierService resource</h2>
        <p>To access the CarrierService resource, add the <code>write_shipping</code> permission to your app's requested scopes. For more information, see <a href="/docs/admin-api/access-scopes"><em>API access scopes</em></a>.</p>
        <p>Your app's request to create a carrier service will fail unless the store installing your carrier service meets one of the following requirements:
          <ul>
            <li>It's on the Advanced Shopify plan or higher.</li>
            <li>It's on the Shopify plan with yearly billing, or the carrier service feature has been added to the store for a monthly fee. For more information, contact <a href="https://help.shopify.com/questions">Shopify Support</a>.</li>
            <li>It's a development store.</li>
          </ul>
        </p>
        <aside class="note">
          <h4>Note</h4>
          <p>If a store changes its Shopify plan, then the store's association with a carrier service is deactivated if the store no long meets one of the requirements above.
          </p>
        </aside>
        <h2>Providing shipping rates to Shopify</h2>
        <p>When adding a carrier service to a store, you need to provide a POST endpoint rooted in the <code>callback_url</code> property where Shopify can retrieve applicable shipping rates. The callback URL should be a public endpoint that expects these requests from Shopify.</p>
        <p><strong>A sample Shopify request for shipping rates:</strong></p>
        <div id="callback-url" class="api-endpoint">
            <div class="api-endpoint-request">
              <pre class="api-endpoint-request-type">POST</pre>
              Your callback URL
            </div>
            <div class="api-endpoint-description">
             <p>Retrieves a list of applicable shipping rates</p>
            </div>
            <div class="api-endpoint-content">
                <div class="api-endpoint-queryparameters"></div>
                <div class="api-endpoint-example">
                  <h3 class="api-endpoint-example-title">Example shipping rate request sent to a carrier service</h3>
                    <pre>
{
  "rate": {
    "origin": {
      "country": "CA",
      "postal_code": "K2P1L4",
      "province": "ON",
      "city": "Ottawa",
      "name": null,
      "address1": "150 Elgin St.",
      "address2": "",
      "address3": null,
      "phone": null,
      "fax": null,
      "email": null,
      "address_type": null,
      "company_name": "Jamie D's Emporium"
    },
    "destination": {
      "country": "CA",
      "postal_code": "K1M1M4",
      "province": "ON",
      "city": "Ottawa",
      "name": "Bob Norman",
      "address1": "24 Sussex Dr.",
      "address2": "",
      "address3": null,
      "phone": null,
      "fax": null,
      "email": null,
      "address_type": null,
      "company_name": null
    },
    "items": [{
      "name": "Short Sleeve T-Shirt",
      "sku": "",
      "quantity": 1,
      "grams": 1000,
      "price": 1999,
      "vendor": "Jamie D's Emporium",
      "requires_shipping": true,
      "taxable": true,
      "fulfillment_service": "manual",
      "properties": null,
      "product_id": 48447225880,
      "variant_id": 258644705304
    }],
    "currency": "USD",
    "locale": "en"
  }
}
                    </pre>
                  <div class="api-endpoint-example-request">
                    <button type="button" class="docs-button-small api-endpoint-example-response-button">View Response</button>
                  </div>
                  <div class="api-endpoint-example-response">
                    <pre>
{
   "rates": [
       {
           "service_name": "canadapost-overnight",
           "service_code": "ON",
           "total_price": "1295",
           "description": "This is the fastest option by far",
           "currency": "CAD",
           "min_delivery_date": "2013-04-12 14:48:45 -0400",
           "max_delivery_date": "2013-04-12 14:48:45 -0400"
       },
       {
           "service_name": "fedex-2dayground",
           "service_code": "2D",
           "total_price": "2934",
           "currency": "USD",
           "min_delivery_date": "2013-04-12 14:48:45 -0400",
           "max_delivery_date": "2013-04-12 14:48:45 -0400"
       },
       {
           "service_name": "fedex-priorityovernight",
           "service_code": "1D",
           "total_price": "3587",
           "currency": "USD",
           "min_delivery_date": "2013-04-12 14:48:45 -0400",
           "max_delivery_date": "2013-04-12 14:48:45 -0400"
       }
   ]
}
                    </pre>
                  </div>
                </div>
              </div>
            </div>

          <p>The <code>address3</code>, <code>fax</code>, <code>address_type</code>, and <code>company_name</code> fields are returned by specific <a href="https://github.com/Shopify/active_shipping">ActiveShipping</a> providers. For API-created carrier services, you should use only the following shipping address fields:</p>
          <ul>
            <li><code>address1</code></li>
            <li><code>address2</code></li>
            <li><code>city</code></li>
            <li><code>zip</code></li>
            <li><code>province</code></li>
            <li><code>country</code></li>
          </ul>
          <p>Other values remain as <code>null</code> and are not sent to the callback URL.</p>

  <h3>Response fields</h3>

  <p>When Shopify requests shipping rates using your callback URL, the response object <code>rates</code> must be
  a JSON array of objects with the following fields.  Required fields must be included in the response for the carrier service integration to work properly.</p>

          <table border="1">
  <tr>
  <td><strong>Field</strong></td>
  <td><strong>Description</strong></td>
  </tr>
  <tr>
  <td><code>service_name</code><br><span class="heading-flag api-property-flag">required</span></td>
  <td>The name of the rate, which customers see at checkout. For example: <code>Expedited Mail</code>.</td>
  </tr>
  <tr>
  <td><code>description</code><br><span class="heading-flag api-property-flag">required</span></td>
  <td>A description of the rate, which customers see at checkout. For example: <code>Includes tracking and insurance</code>.</td>
  </tr>
  <tr>
  <td><code>service_code</code><br><span class="heading-flag api-property-flag">required</span></td>
  <td>A unique code associated with the rate. For example: <code>expedited_mail<code>.</td>
  </tr>
  <tr>
  <td><code>currency</code><br><span class="heading-flag api-property-flag">required</span></td>
  <td>The currency of the shipping rate.</td>
  </tr>
  <tr>
  <td><code>total_price</code><br><span class="heading-flag api-property-flag">required</span></td>
  <td>The total price expressed in subunits. If the currency doesn't use subunits, then the value must be multiplied by 100. For example: `"total_price": 500` for 5.00 CAD, `"total_price": 100000` for 1000 JPY.</td>
  </tr>
  <tr>
  <td><code>phone_required</code></td>
  <td>Whether the customer must provide a phone number at checkout.</td>
  </tr>
  <tr>
  <td><code>min_delivery_date</code></td>
  <td>The earliest delivery date for the displayed rate.</td>
  </tr>
  <tr>
  <td><code>max_delivery_date</code></td>
  <td>The latest delivery date for the displayed rate to still be valid.</td>
  </tr>

  </table>

  <h3>Special conditions</h3>
  <ul>
  <li>To indicate that this carrier service cannot handle this shipping request, return an empty array and any successful (20x) HTTP code.</li>
  <li>To force backup rates instead, return a 40x or 50x HTTP code with any content. A good choice is the regular 404 Not Found code.</li>
  <li>Redirects (30x codes) will only be followed for the same domain as the original callback URL. Attempting to redirect to a different domain will trigger backup rates.</li>
  <li>There is no retry mechanism. The response must be successful on the first try, within the time budget listed below. Timeouts or errors will trigger backup rates.</li>
  </ul>

  <h2>Response Timeouts</h2>
  <p>The read timeout for rate requests are dynamic, based on the number of requests per minute (RPM). These limits are applied to each shop-app pair. The timeout values are as follows.</p>
  <table>
  <tr>
  <td><strong>RPM Range</strong></td>
  <td><strong>Timeout</strong></td>
  </tr>
  <tr>
  <td>Under 1500</td>
  <td>10s</td>
  </tr>
  <tr>
  <td>1500 to 3000</td>
  <td>5s</td>
  </tr>
  <tr>
  <td>Over 3000</td>
  <td>3s</td>
  </tr>
  </table>

  <strong>Note: </strong>These values are upper limits and should not be interpretted as a goal to develop towards. Shopify is constantly evaluating the performance of the platform and working towards improving resilience as well as app capabilities. As such, these numbers may be adjusted outside of our normal versioning timelines.

  <h2>Server-side caching of requests</h2>
  <p>Shopify provides server-side caching to reduce the number of requests it makes. Any shipping rate request that identically matches the following fields will be retrieved from Shopify's cache of the initial response:</p>
  <ul><li>variant IDs</li>
  <li>default shipping box weight and dimensions</li>
  <li>variant quantities</li>
  <li>carrier service ID</li>
  <li>origin address</li>
  <li>destination address</li>
  <li>item weights and signatures</li></ul>
  <p>If any of these fields differ, or if the cache has expired since the original request, then new shipping rates are requested. The cache expires 15 minutes after rates are successfully returned. If an error occurs, then the cache expires after 30 seconds.</p>

## Resource Properties

### CarrierService

* active: Whether this carrier service is active. If <code>true</code>, then the service will be available to serve rates in checkout.

  * Type: x-string
  * Example: true
* callback_url: The URL endpoint that Shopify needs to retrieve shipping rates. This must be a public URL.
  * Type: x-string
  * Example: "http://myapp.com"
* carrier_service_type: Distinguishes between API or legacy carrier services.
  * Type: x-string
  * Example: "api"
* id: The ID of the carrier service.
  * Type: x-string
  * Example: 14079244
* format: The format of the data returned by the URL endpoint. <code>json</code> is the only valid value.
  * Type: x-string
  * Example: "json"
* name: The name of the shipping service as seen by merchants and their customers.
  * Type: x-string
  * Example: "My Carrier Service"
* service_discovery: Whether merchants are able to send dummy data to your service through the Shopify admin to see shipping rate examples.
  * Type: x-string
  * Example: true
* admin_graphql_api_id: The GraphQL GID for this carrier service.
  * Type: x-string
  * Example: "gid://shopify/DeliveryCarrierService/1"
## Create a new CarrierService



### Endpoint
/admin/api/#{api_version}/carrier_services.json (POST)

### Parameters
* api_version (required): 

### Responses
#### 201
Create a new CarrierService

Examples:
##### Create a carrier service
Request:
```
POST /admin/api/unstable/carrier_services.json
{"carrier_service":{"name":"Shipping Rate Provider","callback_url":"http://shipping.example.com","service_discovery":true}}
```

Response:
```
HTTP/1.1 201 Created
{"carrier_service":{"id":1036894960,"name":"Shipping Rate Provider","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894960","format":"json","callback_url":"http://shipping.example.com/"}}
```
## Retrieve a list of CarrierServices

<p>Retrieve a list of CarrierServices. <strong>Note:</strong> Only services with property <code>active: true</code> are returned.</p>

### Endpoint
/admin/api/#{api_version}/carrier_services.json (GET)

### Parameters
* api_version (required): 

### Responses
#### 200
Retrieve a list of CarrierServices

Examples:
##### Retrieve a list of carrier services
Request:
```
GET /admin/api/unstable/carrier_services.json
```

Response:
```
HTTP/1.1 200 OK
{"carrier_services":[{"id":1036894957,"name":"Purolator","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894957","format":"json","callback_url":"http://example.com/"},{"id":260046840,"name":"ups_shipping","active":true,"service_discovery":true,"carrier_service_type":"legacy","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/260046840"}]}
```
## Modify an existing CarrierService

<p>Updates a carrier service. Only the app that creates a carrier service can update it.</p>

### Endpoint
/admin/api/#{api_version}/carrier_services/{carrier_service_id}.json (PUT)

### Parameters
* api_version (required): 
* carrier_service_id (required): 

### Responses
#### 200
Modify an existing CarrierService

Examples:
##### Update a carrier service
Request:
```
PUT /admin/api/unstable/carrier_services/1036894955.json
{"carrier_service":{"id":1036894955,"name":"Some new name","active":false}}
```

Response:
```
HTTP/1.1 200 OK
{"carrier_service":{"active":false,"id":1036894955,"name":"Some new name","service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894955","format":"json","callback_url":"http://example.com/"}}
```
## Receive a single CarrierService



### Endpoint
/admin/api/#{api_version}/carrier_services/{carrier_service_id}.json (GET)

### Parameters
* api_version (required): 
* carrier_service_id (required): 

### Responses
#### 200
Receive a single CarrierService

Examples:
##### Get a single carrier service by its ID
Request:
```
GET /admin/api/unstable/carrier_services/1036894958.json
```

Response:
```
HTTP/1.1 200 OK
{"carrier_service":{"id":1036894958,"name":"Purolator","active":true,"service_discovery":true,"carrier_service_type":"api","admin_graphql_api_id":"gid://shopify/DeliveryCarrierService/1036894958","format":"json","callback_url":"http://example.com/"}}
```
## Remove an existing CarrierService



### Endpoint
/admin/api/#{api_version}/carrier_services/{carrier_service_id}.json (DELETE)

### Parameters
* api_version (required): 
* carrier_service_id (required): 

### Responses
#### 200
Remove an existing CarrierService

Examples:
##### Delete a carrier service
Request:
```
DELETE /admin/api/unstable/carrier_services/1036894956.json
```

Response:
```
HTTP/1.1 200 OK
{}
```