Tax Identification Number
Include a tax identification number to associate with your shipments.
About the tax identification number
A tax identification number, or employer identification number (EIN), is assigned and used by the Internal Revenue Service to identify a business entity. A tax ID number is required for customs when shipping internationally.
Within the Shipium system, you can provide your tax ID number via Shipium Console configuration and API call.
API call value overrides console configuration
If you pass a tax ID number (using
taxIdentificationNumber
) in your calls to Shipium's APIs, any value you have configured for tax ID number in the Shipium Console will be overridden by the value included in the API call.
Configure your tax ID number in the Shipium Console
You can configure your tax ID number in the Shipium Console during fulfillment context setup. A fulfillment context allows you to configure the characteristics for your network origins, carrier contracts, label augmentations, third party billing, injection shipping, and tenants, in addition to other feature settings.
Guidance for establishing your tax ID number as part of fulfillment context configuration can be found in the Fulfillment Contexts documentation.
Pass your tax ID number via API call
You also may include a tax ID number when calling Shipium's Carrier and Method Selection & Shipment Label and Carrier and Method Selection APIs. Including a tax ID number in the API calls described below will override any tax ID value you have configured for a fulfillment context in the Shipium Console.
Carrier and Method Selection & Shipment Label API for single-parcel shipments
As described in the request field table in the Carrier and Method Selection & Shipment Label API documentation, the optional taxIdentificationNumber
value can be included in the shipment parameters of your call to this API.
{
"shipmentParameters": {
"partnerShipmentId": "MY_SHIPMENT_001",
"shippedDateTime": "2019-10-29T09:12:33.123456Z",
...
"taxIdentificationNumber": "12-3456789"
...
}
}
Carrier and Method Selection & Shipment Label API for multi-parcel shipments
For multi-parcel shipments, the optional taxIdentificationNumber
value can be included in the multi-parcel shipment parameters of your call to the Carrier and Method Selection & Shipment Label API. You can find further guidance for using this API for multi-parcel shipments in the Multi-Parcel Shipments document. However, the following code block demonstrates inclusion of the tax ID.
{
"multiParcelshipmentParameters": {
"partnerShipmentId": "MY_SHIPMENT_001",
"shippedDateTime": "2019-10-29T09:12:33.123456Z",
...
"taxIdentificationNumber": "12-3456789"
...
}
}
Carrier and Method Selection API
As described in the request field table in the Carrier and Method Selection API documentation, the optional taxIdentificationNumber
value can be included in the body of the shipment entity of your call to this API.
{
"partnerShipmentId": "MY_SHIPMENT_001",
"shippedDateTime": "2019-10-29T09:12:33.123456Z",
...
"taxIdentificationNumber": "12-3456789"
...
}
Resources
Your Shipium team member is available to help along the way. However, you might find these resources helpful:
Updated 7 days ago