[v2.6] Carrier

Owned by Megan Stanage
Sept 05, 2024
1 min read

Overview

This endpoint allows you to get a list of enabled carrier services for outbound parcel and LTL shipping.

It also allows you to add carriers to Supply Chain Cloud to assign them to shipments and tenders for fulfillment to customers.

GET /Carrier/GetCarrierServicesEnabled


 Response
PropertyData TypeNotes
namestringCarrier name.
carrierTypeenum
  • Parcel
  • Ltl


 carrierServices
PropertyData TypeNotes
namestringCarrier service name.
externalCodestringCode used to reference service on the carrier side.





POST /Carrier


 Request Body
PropertyData TypeNotes
namestring
descriptionstring
activeboolean
websitestring
accessGroupstring


 address
PropertyData TypeNotes
namestringmax length: 100
companystringmax length: 150
attentionTostringmax length: 150
addressLinesstring
citystringmax length: 150
postalCodestringmax length: 15
stateProvinceCodestringmax length: 5
countrystring
countryCodestringmax length: 5
phoneNumberstringmax length: 20
residentialboolean
taxIdstring
emailAddressstringmax length: 400
countystringmax length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 contacts
PropertyData TypeNotes
namestring
phonestring
emailstring
isDefaultEmailboolean
isDefaultPhoneboolean
 systemAttributes
PropertyData TypeNotes
attributeNamestringGets or sets the attribute name.
attributeDescriptionstringGets or sets the attribute description.
valuestringGets or sets the system attribute value.
 carrierServices
PropertyData TypeNotes
namestring
externalCodestring
 Response
PropertyData TypeNotes
savedCarriersstring
 saveFailures
PropertyData TypeNotes
namestring
errorMessagestring

Feedback

Submit feedback.