Partner Rating Endpoint

The partner rating endpoint is only available to approved partners.
Interested in joining our partner program? Contact us to get started.

The partner rating endpoint allows third-party applications to call Intuitive Shipping directly.

POST Method Endpoint

A custom rating endpoint will be provided to you upon approval into the partner program.

Request Headers

curl -X POST \ {partner_endpoint} \
  -H 'Content-Type: application/json' \
  -H 'X-Shopify-Domain: {shopify_domain}' \
  -H 'X-Api-Key: {api_key}' \
  -H 'X-Partner-Key: {partner_key} '\
{partner_endpoint}

A custom rating endpoint will be provided to you upon approval.

{shopify_domain}

The full Shopify domain of the shop that the rating request is being performed on. For example test-store.myshopify.com.

{api_key}

A unique API key is associated with each shop account. The API key can be located within the Intuitive Shipping user interface under the Partners page.

{partner_key}

A unique partner key will be provided to you upon approval.

Example Request Payload

{
  "rate": {
    "origin": {
      "country": "CA",
      "postal_code": "K2P1L4",
      "province": "ON",
      "city": "Ottawa",
      "name": null,
      "address1": "150 Elgin St.",
      "address2": "",
      "address3": null,
      "phone": "16135551212",
      "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"
  }
}

Example Response

{
   "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"
       }
   ]
}

Support

If you have any questions, please contact us for assistance.

Updated on January 8, 2022

Was this article helpful?

Related Articles

Need Support?
Can't find the answer you're looking for?
Contact Support