Docs
Contract APIs
Shipping provider

Shipping Providers

Implement endpoints consumed by BigCommerce for custom shipping integrations. To learn more, see Shipping Provider API Overview.

Authentication

This specification file describes API requests BigCommerce will make to a registered shipping carrierʼs server to check connection options and retrieve rates. As such, the method of authentication is determined by the carrier server.

For more, see developer-configured authentication for provider APIs.

Subresources

Check Connection Options

The Check Connection Options request is made by BigCommerce when checking for available shipping options. Each Shipping Provider will have different configurations for the payload.

Rate

The Rate request is made by BigCommerce to get shipping quotes from the provider.

Additional Information

Webhooks

Related API Resources

Request shipping rates

POST /rate

Request

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.

Parameters

  • app_domain in path - string
Rate request object.

Body

object | application/json
Payload sent to a Shipping Provider to get quotes.

  • base_options    object
    required

    The minimum required payload that is sent to retrieve rates.

  • zone_options    object

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

  • connection_options    object

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

example

Response

Quote response.

Body

object | application/json
The response from the Shipping Service. Contains zero or more quotes.

  • quote_id    string
    required

    <= 50 characters

  • ttl    integer

    Time-to-live (TTL) in seconds

  • messages    array[object]
    required

  • carrier_quotes    array[object]
    required

With shipping rates

Without shipping rates

Validate connection options

POST /check_connection_options

Request

Validate connection options. BigCommerce sends a request to the shipping provider URL to check a merchantʼs connection credentials. The shipping provider sends a response indicating whether a merchant has valid credentials.

Note

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

Parameters

  • app_domain in path - string
Check connection options request.

Body

object | application/json

The payload sent to a Shipping Provider to check that the store is connected to this provider.

Each Shipping Provider will have different configurations for the payload.

  • connection_options    object
    required

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

example

Response

Check connection options response.

Body

object | application/json
The response received back from the Shipping Provider connection check. This allows the store to understand whether the connection was successful.

  • valid    boolean

    Indicates whether or not the connection options are valid.

  • messages    array[object]

response

See something you can improve? Edit this file on GitHub

Did you find what you were looking for?
OverviewRequest shipping rates