For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dev Portal
DocsAPI ReferenceLearnCommunityChangelog
DocsAPI ReferenceLearnCommunityChangelog
    • About Our APIs
  • REST
    • Overview
      • Overview
      • Shipping Provider
          • POSTRequest Shipping Rates
          • POSTValidate Connection Options
      • Tax Provider
      • Webhooks
  • GraphQL
    • Overview
  • MCP
    • Overview
Dev Portal
LogoLogo
RESTIntegrationsShipping Provider

Request Shipping Rates

POST
https://your_app.example.com/rate
POST
/rate
$curl -X POST https://your_app.example.com/rate \
>     -H "Content-Type: application/json" \
>     -d '{
>  "base_options": {
>    "origin": {
>      "zip": "94105",
>      "country_iso2": "US"
>    },
>    "destination": {
>      "zip": "94105",
>      "country_iso2": "US"
>    },
>    "items": [
>      {}
>    ],
>    "store_id": "string"
>  }
>}'
1{
2  "quote_id": "Lor",
3  "messages": [
4    {
5      "text": "ni",
6      "type": "INFO"
7    }
8  ],
9  "carrier_quotes": [
10    {
11      "quotes": [
12        {
13          "code": "GND",
14          "display_name": "cillum",
15          "cost": {
16            "currency": "BEH",
17            "amount": 53116961.83460022
18          },
19          "messages": [
20            {
21              "text": "deserunt",
22              "type": "INFO"
23            },
24            {
25              "text": "ut",
26              "type": "ERROR"
27            },
28            {
29              "text": "c",
30              "type": "WARNING"
31            },
32            {
33              "text": "veniam",
34              "type": "ERROR"
35            }
36          ],
37          "description": "el",
38          "rate_id": "n",
39          "discounted_cost": {
40            "currency": "VQD",
41            "amount": 16810732.187082157
42          },
43          "dispatch_date": "1947-07-10",
44          "transit_time": {
45            "units": "DAYS",
46            "duration": 74
47          }
48        },
49        {
50          "code": "GND",
51          "display_name": "",
52          "cost": {
53            "currency": "PRZ",
54            "amount": 85659359.530116
55          },
56          "messages": [
57            {
58              "text": "consequat",
59              "type": "ERROR"
60            },
61            {
62              "text": "eu e",
63              "type": "WARNING"
64            },
65            {
66              "text": "adip",
67              "type": "ERROR"
68            },
69            {
70              "text": "enim no",
71              "type": "ERROR"
72            },
73            {
74              "text": "eu",
75              "type": "ERROR"
76            }
77          ],
78          "description": "cillum ve",
79          "rate_id": "ea ad",
80          "discounted_cost": {
81            "currency": "XRQ",
82            "amount": 69218406.22440869
83          },
84          "dispatch_date": "1954-03-05",
85          "transit_time": {
86            "units": "HOURS",
87            "duration": 21
88          }
89        },
90        {
91          "code": "GND",
92          "display_name": "dolor rep",
93          "cost": {
94            "currency": "VOF",
95            "amount": 29865288.150019586
96          },
97          "messages": [
98            {
99              "text": "in id",
100              "type": "INFO"
101            },
102            {
103              "text": "et occa",
104              "type": "ERROR"
105            },
106            {
107              "text": "esse dolo",
108              "type": "INFO"
109            },
110            {
111              "text": "dolor",
112              "type": "ERROR"
113            },
114            {
115              "text": "ex",
116              "type": "ERROR"
117            }
118          ],
119          "description": "ullamco",
120          "rate_id": "",
121          "discounted_cost": {
122            "currency": "CKD",
123            "amount": 18401337.766514115
124          },
125          "dispatch_date": "1993-06-23",
126          "transit_time": {
127            "units": "HOURS",
128            "duration": 54
129          }
130        }
131      ],
132      "carrier_info": {
133        "code": "",
134        "display_name": "c"
135      }
136    },
137    {
138      "quotes": [
139        {
140          "code": "GND",
141          "display_name": "labore",
142          "cost": {
143            "currency": "OHQ",
144            "amount": 63679444.026082255
145          },
146          "messages": [
147            {
148              "text": "offici",
149              "type": "INFO"
150            },
151            {
152              "text": "dolore",
153              "type": "ERROR"
154            },
155            {
156              "text": "nis",
157              "type": "WARNING"
158            },
159            {
160              "text": "ma",
161              "type": "WARNING"
162            }
163          ],
164          "description": "in r",
165          "rate_id": "l",
166          "discounted_cost": {
167            "currency": "UBE",
168            "amount": 40327578.11995282
169          },
170          "dispatch_date": "1943-09-25",
171          "transit_time": {
172            "units": "DAYS",
173            "duration": 10
174          }
175        },
176        {
177          "code": "GND",
178          "display_name": "irure",
179          "cost": {
180            "currency": "PEJ",
181            "amount": 56049316.6584908
182          },
183          "messages": [
184            {
185              "text": "cillum a",
186              "type": "INFO"
187            }
188          ],
189          "description": "nisi",
190          "rate_id": "",
191          "discounted_cost": {
192            "currency": "VFS",
193            "amount": 86177946.62739782
194          },
195          "dispatch_date": "1999-01-13",
196          "transit_time": {
197            "units": "DAYS",
198            "duration": 11
199          }
200        }
201      ],
202      "carrier_info": {
203        "code": "consect",
204        "display_name": "eiusmod"
205      }
206    },
207    {
208      "quotes": [
209        {
210          "code": "GND",
211          "display_name": "ullamc",
212          "cost": {
213            "currency": "NRB",
214            "amount": 75971681.09105605
215          },
216          "messages": [
217            {
218              "text": "laborum",
219              "type": "INFO"
220            },
221            {
222              "text": "proident i",
223              "type": "WARNING"
224            },
225            {
226              "text": "sin",
227              "type": "ERROR"
228            },
229            {
230              "text": "volup",
231              "type": "ERROR"
232            },
233            {
234              "text": "deser",
235              "type": "WARNING"
236            }
237          ],
238          "description": "am",
239          "rate_id": "mo",
240          "discounted_cost": {
241            "currency": "NPA",
242            "amount": 72743924.13626081
243          },
244          "dispatch_date": "2006-01-17",
245          "transit_time": {
246            "units": "BUSINESS_DAYS",
247            "duration": 52
248          }
249        },
250        {
251          "code": "GND",
252          "display_name": "dolor",
253          "cost": {
254            "currency": "RDZ",
255            "amount": 46371179.641438134
256          },
257          "messages": [
258            {
259              "text": "ex",
260              "type": "WARNING"
261            },
262            {
263              "text": "ipsum",
264              "type": "WARNING"
265            }
266          ],
267          "description": "",
268          "rate_id": "aute c",
269          "discounted_cost": {
270            "currency": "SJL",
271            "amount": 60745150.4084129
272          },
273          "dispatch_date": "1976-06-19",
274          "transit_time": {
275            "units": "DAYS",
276            "duration": 69
277          }
278        },
279        {
280          "code": "GND",
281          "display_name": "minim a",
282          "cost": {
283            "currency": "SUR",
284            "amount": 97146769.48560241
285          },
286          "messages": [
287            {
288              "text": "Lorem",
289              "type": "INFO"
290            }
291          ],
292          "description": "de",
293          "rate_id": "fu",
294          "discounted_cost": {
295            "currency": "PCP",
296            "amount": 99728805.8108871
297          },
298          "dispatch_date": "1962-05-18",
299          "transit_time": {
300            "units": "DAYS",
301            "duration": 10
302          }
303        },
304        {
305          "code": "GND",
306          "display_name": "ea occaeca",
307          "cost": {
308            "currency": "YOG",
309            "amount": 51938381.743391246
310          },
311          "messages": [
312            {
313              "text": "in irure",
314              "type": "INFO"
315            },
316            {
317              "text": "c",
318              "type": "INFO"
319            },
320            {
321              "text": "deserun",
322              "type": "ERROR"
323            },
324            {
325              "text": "dolo",
326              "type": "ERROR"
327            }
328          ],
329          "description": "dol",
330          "rate_id": "U",
331          "discounted_cost": {
332            "currency": "HMF",
333            "amount": 98693839.53819382
334          },
335          "dispatch_date": "2010-08-15",
336          "transit_time": {
337            "units": "HOURS",
338            "duration": 31
339          }
340        },
341        {
342          "code": "GND",
343          "display_name": "sint",
344          "cost": {
345            "currency": "TTO",
346            "amount": 65094224.57995142
347          },
348          "messages": [
349            {
350              "text": "ut",
351              "type": "INFO"
352            }
353          ],
354          "description": "labo",
355          "rate_id": "anim ma",
356          "discounted_cost": {
357            "currency": "ZMA",
358            "amount": 57479313.52475042
359          },
360          "dispatch_date": "2008-10-24",
361          "transit_time": {
362            "units": "DAYS",
363            "duration": 55
364          }
365        }
366      ],
367      "carrier_info": {
368        "code": "dol",
369        "display_name": "commodo"
370      }
371    },
372    {
373      "quotes": [
374        {
375          "code": "GND",
376          "display_name": "sed",
377          "cost": {
378            "currency": "BOE",
379            "amount": 9130506.016241236
380          },
381          "messages": [
382            {
383              "text": "i",
384              "type": "ERROR"
385            },
386            {
387              "text": "dolore",
388              "type": "WARNING"
389            },
390            {
391              "text": "ut",
392              "type": "INFO"
393            },
394            {
395              "text": "nos",
396              "type": "ERROR"
397            }
398          ],
399          "description": "",
400          "rate_id": "c",
401          "discounted_cost": {
402            "currency": "QGD",
403            "amount": 81757709.40827666
404          },
405          "dispatch_date": "1999-11-11",
406          "transit_time": {
407            "units": "HOURS",
408            "duration": 6
409          }
410        },
411        {
412          "code": "GND",
413          "display_name": "do aute",
414          "cost": {
415            "currency": "IQW",
416            "amount": 83709032.8238562
417          },
418          "messages": [
419            {
420              "text": "ess",
421              "type": "ERROR"
422            },
423            {
424              "text": "an",
425              "type": "WARNING"
426            },
427            {
428              "text": "Duis",
429              "type": "ERROR"
430            },
431            {
432              "text": "ipsum",
433              "type": "WARNING"
434            },
435            {
436              "text": "do",
437              "type": "WARNING"
438            }
439          ],
440          "description": "amet",
441          "rate_id": "veniam",
442          "discounted_cost": {
443            "currency": "YYL",
444            "amount": 11005656.662449125
445          },
446          "dispatch_date": "1980-05-16",
447          "transit_time": {
448            "units": "HOURS",
449            "duration": 32
450          }
451        }
452      ],
453      "carrier_info": {
454        "code": "vel",
455        "display_name": "laborum e"
456      }
457    }
458  ]
459}
Request shipping rates. BigCommerce sends a request for shipping quotes to the shipping provider URL. The shipping provider responds with shipping quotes. > #### Note > * Substitute the host and path specific to the shipping provider for `your_app.example.com` and `rate`. > * The Send a Test Request feature is not currently supported for this endpoint.
Was this page helpful?
Previous

Shipping Providers

Next

Validate Connection Options

Built with

Request shipping rates. BigCommerce sends a request for shipping quotes to the shipping provider URL. The shipping provider responds with shipping quotes.

Note

  • Substitute the host and path specific to the shipping provider for your_app.example.com and rate.
  • The Send a Test Request feature is not currently supported for this endpoint.

Request

Rate request object.
base_optionsobjectRequired
The minimum required payload that is sent to retrieve rates.
zone_optionsobjectOptional

Any zone-specific request options declared by the carrier and configured by the merchant to retrieve rates. Optional.

connection_optionsobjectOptional
Any global request options declared by the carrier and configured by the merchant to retrieve rates. Optional.

Response

Quote response.
quote_idstring<=50 characters
messageslist of objects
carrier_quoteslist of objects
ttlinteger

Time-to-live (TTL) in seconds