[v2.6] ProNumber

Overview

This endpoint allows the user to generate a PRO number when requested.


POST /ProNumber/Generate


 Request Body
PropertyData TypeNotes
orderNumberstringOrder number.
carrierNamestring

Carrier name.

Must exactly match carrier name in SCC.

accountNumberstringAccount number for that carrier.
isProductionbooleanTrue or false.
includeTransactionXmlsbooleanTrue or false.
transactionHistoryProcessenum

Either option works:

  • ApiPackStation
  • Api


 origin
PropertyData TypeNotes
namestring

Name of origin for shipment.

  • max length: 100
companystring

Company at the origin.

  • max length: 150
attentionTostring

Attention To at the origin.

This will be used for returns, if necessary.

  • max length: 150
addressLinesstringStreet Number, Street Name, Suite Number, etc.
citystring

City of shipment origin.

  • max length: 150
postalCodestring

Postal code of shipment origin.

  • max length: 15
stateProvinceCodestring

State/Province code of shipment origin.

  • max length: 5
countrystringFull name of country.
countryCodestring

Country code at origin.

  • max length: 5
phoneNumberstring
  • max length: 20
residentialbooleanTrue or false.
taxIdstring

The tax identifier for the party at origin.

This can be an EORI, VAT, or exporter ID.

emailAddressstring
  • max length: 400
countystring

Optional.

  • max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstringNot applicable.
eoristringNot applicable.

 Response
PropertyData TypeNotes
proNumberstringPRO number for the shipment.
runTimeinteger
  • int32
transactionIdstringSystem-generated transaction ID.


 transactionHistoryInterfaces
PropertyData TypeNotes
carrierRequeststringCarrier API request.
carrierResponsestringCarrier API response.
sccRequeststringNot applicable.
sccResponsestringNot applicable.
carrierTransactionId
stringCarrier-generated transaction ID.



Feedback

Submit feedback.