Skip to content
English
Go to shippypro.com
  • There are no suggestions because the search field is empty.

API Carrier Configuration: Common Integration Questions

Can you create multiple API carrier connections for the same carrier?

Yes. You can create as many carrier connections as needed, even with different credentials for each connection. Each connection generates a unique carrier ID, and that carrier ID must be inserted in the Ship API request.

How do you configure carrier options in the Ship API?

You can add carrier options directly in the Ship API call.

  1. Go to the API section.
  2. Scroll to the Carrier List.
  3. Use Show Carrier Option to check the correct syntax for the option you want to use.
  4. Add the option to your Ship API request.

Carrier options can also be activated through the platform during rate comparison by clicking + Carrier Option.

How do you choose the correct carrier credential or API key?

It depends on the integration type:

  • ShippyPro API key: available in API section
  • Carrier credentials: provided by the carrier and entered in the carrier connection
  • Marketplace credentials: taken from the external marketplace account 
How does service configuration work for carrier connections?

One connection uses one service. If you need more than one service, you should create a separate connection for each service.

How are carrier option and service compatibility determined?

Compatibility is determined by the carrier’s requirements and the terms of your contract with the carrier. For exact valid combinations, check the carrier’s specifications and use the request payload details to verify the service and carrier options being sent.