Create & Assign 3rdParty Account to Shipment Order

Overview

This document explains how to add a 3rd party account to a shipment order using the insert shipment order API endpoint. The process will automatically create and assign the account number to the order if it is not already set up under the carrier.

Endpoint Information

Endpoint: /ShipmentOrder/create

Request Parameters

Here are the key parameters you need to include in your request:

shippingOptionDetails
- shippingOptionName: Specify the shipping option (e.g., "First").
- carrierName: The name of the carrier (e.g., "USPS").
- carrierSetupName: The carrier setup name within your system (e.g., "Easypost_Test").
- isSetUnmatchedShippingOptionAsRequested: Set to true to automatically set unmatched shipping options as requested.
channelSetupIdentifier ( This field can be used instead of "shippingOptionDetails"
- This unique identifier links the shipment order to a specific channel setup.
chargedAccountNumber
- Provide the 3rd party account number here (e.g., "080820243"). If this account number doesn't exist, it will be automatically created and assigned under the carrier setup.
chargedAccountCountryCode
- The country code associated with the 3rd party account (e.g., "US").
chargedAccountPostalCode
- The postal code associated with the 3rd party account (e.g., "16123").

Alternative Option

Instead of using shippingOptionDetails, you can opt to use shippingOptionIdentifier if it is more convenient for your implementation.

Example Request Body Scenario 1 :

{
 "shippingOptionDetails": {
  "shippingOptionName": "First",
  "carrierName": "USPS",
  "carrierSetupName": "Easypost_Test",
  "isSetUnmatchedShippingOptionAsRequested": true
 },
 "chargedAccountNumber": "080820243",
 "chargedAccountCountryCode": "US",
 "chargedAccountPostalCode": "16123"
}

Example Request Body Scenario 2 :

{
 "channelSetupIdentifier": "54e49f87-bb42-4a54-8f86-5dab7be8c0b4",
 "chargedAccountNumber": "080820243",
 "chargedAccountCountryCode": "US",
 "chargedAccountPostalCode": "16123"
}

Notes

If the chargedAccountNumber is not already set up under the carrier, it will be automatically created and assigned to the order.
The shippingOptionIdentifier can be used as an alternative to shippingOptionDetails if preferred.

Support

For any further assistance or questions, please contact our support team.

Create a Shipment Order

Add a Tracking Number to a Shipment Order

Create a Shipment Order Workflow

Workflow Actions

Custom Carrier Field Map