[v1] ProNumber
Megan Stanage
Overview
This endpoint generates a PRO number for the referenced shipment.
If you are using the PRO number generation engines in SCC, this generates the next in sequence.
If you are getting PRO numbers directly from the carrier, this returns whatever the carrier assigns.
POST /ProNumber
| Property | Data Type | Notes |
|---|---|---|
| includeTransactions | boolean | Gets or sets a flag that dictates if this request should include transactions in the response. |
| isProduction | boolean | Gets or sets a flag that dictates to send to test or production endpoints. |
| orderNumber | string | Gets or sets order number. |
Gets or sets the carrier webservice details in the request.
| Property | Data Type | Notes |
|---|---|---|
| integrationName | string | Gets or sets the name of the carrier's integration. |
| carrierName | string | Gets or sets the name of the carrier used for the provided integration. |
| credentialSetName | string | Gets or sets the identifier for the set of account credentials to be looked up for the provided integration. |
| billingAccountNumber | string | Gets or sets the account number to be billed for this request. |
| thirdPartyBillingAccountNumber | string | Gets or sets the account number to be billed when the request requires another account to pay. |
Gets or sets origin address.
| Property | Data Type | Notes |
|---|---|---|
| countryCode | string | Gets or sets the country code, expecting ISO2 formatting. |
| postalCode | string | Gets or sets the postal code in different country formats. |
| city | string | Gets or sets the name of the city. |
| addressLines | string | Gets or sets the address lines that represent the street address. |
| stateProvinceCode | string | Gets or sets the state or province code in the expected country format. |
| companyName | string | Gets or sets the name of the company that this address represents. |
| name | string | Gets or sets the name of the contact. |
| emailAddress | string | Gets or sets the email address of the contact. |
| phoneNumber | string | Gets or sets the phone number of the contact. |
PRO number response provided back to external systems from pro number operation executed in a specified carrier integration's webservice or in our internal pro number generation service.
| Property | Data Type | Notes |
|---|---|---|
| runTime | integer | Gets or sets the run time for creating a response for the incoming request in the LTL API.
|
Gets or sets list of response messages.
| Property | Data Type | Notes |
|---|---|---|
| value | string | Gets or sets the message text content. |
| severity | enum | Gets or sets the type of message severity.
|
Gets or sets the carrier pro number response.
| Property | Data Type | Notes |
|---|---|---|
| proNumber | string | Gets or sets pro number. |
Gets or sets list of response messages.
| Property | Data Type | Notes |
|---|---|---|
| value | string | Gets or sets the message text content. |
| severity | enum | Gets or sets the type of message severity.
|
Gets or sets list of transactions.
| Property | Data Type | Notes |
|---|---|---|
| transactionId | string | Gets or sets the transaction ID used for the request. |
| endpoint | string | Gets or sets the endpoint used for the request. |
| request | string | Gets or sets the transaction request content. |
| response | Gets or sets the transaction response content. |
Gets or sets the collection of carrier transactions.
| Property | Data Type | Notes |
|---|---|---|
| transactionId | string | Gets or sets the transaction ID used for the request. |
| endpoint | string | Gets or sets the endpoint used for the request. |
| request | string | Gets or sets the transaction request content. |
| response | Gets or sets the transaction response content. |