[v2.6] ProNumber
- Megan Stanage
Owned by Megan Stanage
Sept 06, 2024
1 min read
Loading data...
Overview
This endpoint allows the user to generate a PRO number when requested.
POST /ProNumber/Generate
Request Body
Property | Data Type | Notes |
---|---|---|
orderNumber | string | Order number. |
carrierName | string | Carrier name. Must exactly match carrier name in SCC. |
accountNumber | string | Account number for that carrier. |
isProduction | boolean | True or false. |
includeTransactionXmls | boolean | True or false. |
transactionHistoryProcess | enum | Either option works:
|
origin
Property | Data Type | Notes |
---|---|---|
name | string | Name of origin for shipment.
|
company | string | Company at the origin.
|
attentionTo | string | Attention To at the origin. This will be used for returns, if necessary.
|
addressLines | string | Street Number, Street Name, Suite Number, etc. |
city | string | City of shipment origin.
|
postalCode | string | Postal code of shipment origin.
|
stateProvinceCode | string | State/Province code of shipment origin.
|
country | string | Full name of country. |
countryCode | string | Country code at origin.
|
phoneNumber | string |
|
residential | boolean | True or false. |
taxId | string | The tax identifier for the party at origin. This can be an EORI, VAT, or exporter ID. |
emailAddress | string |
|
county | string | Optional.
|
identificationNumbers
Property | Data Type | Notes |
---|---|---|
vat | string | Not applicable. |
eori | string | Not applicable. |
Response
Property | Data Type | Notes |
---|---|---|
proNumber | string | PRO number for the shipment. |
runTime | integer |
|
transactionId | string | System-generated transaction ID. |
transactionHistoryInterfaces
Property | Data Type | Notes |
---|---|---|
carrierRequest | string | Carrier API request. |
carrierResponse | string | Carrier API response. |
sccRequest | string | Not applicable. |
sccResponse | string | Not applicable. |
carrierTransactionId | string | Carrier-generated transaction ID. |