[v2.6] Shipment

Owned by Megan Stanage
Sept 10, 2024
5 min read

Overview

This endpoint allows a user to create or update shipments within SCC. 

A shipment can be a standalone shipment or tied to a transportation tender.  

POST /Shipment


 Request Body
 shipment

Represents the shipment structure.

PropertyData TypeNotes
stopSequenceinteger

Gets or sets the stop sequence.

  • int32
originLocationNamestring

Gets or sets the origin location name.

freightTermenum

Gets or sets the freight term.

  • Shipper
  • Receiver
  • Consignee
  • ThirdParty
termsOfTradeenum

Gets or sets the terms of trade.

  • Ddp
  • Dap
  • Dtp
proNumberstringGets or sets the PRO number.
scacstring

Gets or sets the standard carrier alpha code.

loadstring

Gets or sets the load.

currencyCodeenum

Gets or sets the currency code.

USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG

carrierServiceNamestring

Gets or sets the carrier service name.

customerIdstringGets or sets the customer ID.
customerNamestring

Gets or sets the customer name.

customerEmailstringGets or sets the customer email.
customerThirdPartyAccountNumberstring

Gets or sets the customer third-party account number.

deliveryNotesstring

Gets or sets the delivery notes.

transportationTenderReferenceNumberstring

Gets or sets the transportation tender reference number.

fixedRouteStopNamestring

Gets or sets the fixed route stop name.

scheduledShipDateTimestring

Gets or sets the scheduled ship date time.

  • date-time
actualShipDateTimestring

Gets or sets the actual ship date time.

  • date-time
tenderedShipDateTimestring

Gets or sets the tendered ship date time.

  • date-time
apiCallDateTimestring

Gets or sets the API call date time.

  • date-time
estimatedDeliverDateTimeStartstring

Gets or sets estimated deliver date time start selected from slot.

  • date-time
estimatedDeliverDateTimeEndstring

Gets or sets estimated deliver date time end selected from slot.

  • date-time

actualDeliverDateTime

string

Gets or sets the actual delivery date time.

  • date-time
requestedDeliverByDateTimestring

Gets or sets the requested delivery date time.

  • date-time
requestedDeliverAfterDateTimestring

Gets or sets the requested delivery after date time.

  • date-time
arrivalDateTimestring

Gets or sets the arrival date time.

  • date-time
departureDateTimestring

Gets or sets the departure date time.

  • date-time
routingCodestring

Gets or sets the routing code.


 originAddress

Gets or sets the origin address.

PropertyData TypeNotes
name
stringmax 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
county

string


max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 destinationAddress

Gets or sets the destination address.

PropertyData TypeNotes
name
stringmax 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
county

string


max length: 30


 identificationNumbers
PropertyData TypeNotes
vatstring
eoristring
 systemAttributes

Gets or sets the list of associated system attributes.

PropertyData TypeNotes
attributeNamestringGets or sets the attribute name.
attributeDescriptionstringGets or sets the attribute description.
valuestringGets or sets the system attribute value.
 shipmentLines

Gets or sets the shipment lines.

PropertyData TypeNotes
lineNumberinteger

Gets or sets the unique line number within the shipment.

  • int32
originLineReferenceIdstring

Gets or sets the origin line reference ID.

  • Max length: 100
originHeaderReferenceIdstring

Gets or sets the origin header reference ID.

  • Max length: 200
purchaseOrderReferenceNumberstring

Gets or sets the purchase order reference number.

  • Max length: 100
purchaseOrderLineNumberinteger

Gets or sets the purchase order line number.

  • int32
hostItemstringGets or sets the host item.
itemIdstring

Gets or sets the item ID.

  • Max length: 100
itemNamestring

Gets or sets the item name.

  • Max length: 100
lengthnumber

Gets or sets the length of the item.

  • Decimal
widthnumber

Gets or sets the width of the item.

  • Decimal
heightnumber

Gets or sets the height of the item.

  • Decimal
itemCountryOfOriginstring

Gets or sets the item origin country.

  • Max length: 2
dimensionUomenum

Gets or sets the item dimension UOM.

  • Inch
  • Cm
weightnumber

Gets or sets the weight of the item.

  • Decimal
weightUomenum

Gets or sets the weight UOM.

  • Lb
  • Oz
  • Kg
valuenumber

Gets or sets the item cost value.

  • decimal
currencyCodeenum

Gets or sets the item value currency code.

USD, CAD, AUD, GBP, EUR, DKK, SEK, NOK, CZK, CHF, HUF, PLN, MXN, PHP, SAR, JPY, AFN, ALL, DZD, AOA, XCD, ARS, AMD, AWG, AZN, BSD, BHD, BDT, BBD, BYN, BZD, XOF, BMD, INR, BTN, BOB, BOV, BAM, BWP, BRL, BND, BGN, BIF, CVE, KHR, XAF, KYD, CLP, CLF, CNY, COP, COU, KMF, CDF, NZD, CRC, CUP, CUC, ANG, DJF, DOP, EGP, SVC, ERN, SZL, ETB, FKP, FJD, XPF, GMD, GEL, GHS, GIP, GTQ, GNF, GYD, HTG, HNL, HKD, ISK, IDR, XDR, IRR, IQD, ILS, JMD, JOD, KZT, KES, KPW, KRW, KWD, KGS, LAK, LBP, LSL, ZAR, LRD, LYD, MOP, MKD, MGA, MWK, MYR, MVR, MRU, MUR, XUA, MXV, MDL, MNT, MAD, MZN, MMK, NAD, NPR, NIO, NGN, OMR, PKR, PAB, PGK, PYG, PEN, QAR, RON, RUB, RWF, SHP, WST, STN, RSD, SCR, SLL, SLE, SGD, XSU, SBD, SOS, SSP, LKR, SDG, SRD, CHE, CHW, SYP, TWD, TJS, TZS, THB, TOP, TTD, TND, TRY, TMT, UGX, UAH, AED, USN, UYU, UYI, UYW, UZS, VUV, VES, VED, VND, YER, ZMW, ZWL, XBA, XBB, XBC, XBD, XTS, XXX, XAU, XPD, XPT, XAG

requestedQuantitynumber

Gets or sets the requested quantity.

  • decimal
shippedQuantitynumber

Gets or sets the shipped quantity.

  • decimal
deliveredQuantitynumber

Gets or sets the delivered quantity.

  • decimal
quantityUomstring

Gets or sets the quantity UOM.

  • max length: 50
shippableUnitbooleanGets or sets a value indicating whether it is a shippable unit.
purchaseOrderTransactionTypestringGets or sets name of purchase order's transaction type.




 systemAttributes

Gets or sets the associated system attributes.

PropertyData TypeNotes
attributeNamestringGets or sets the attribute name.
attributeDescriptionstringGets or sets the attribute description.
valuestringGets or sets the system attribute value.
 batches

Gets or sets batches.

PropertyData TypeNotes
namestring

Gets or sets the batch name.

expirationDatestring

Gets or sets a value indicating the expiration date.

  • date-time
manufacturedDatestring

Gets or sets a value indicating the manufacture date.

  • date-time
countryOfOriginstringGets or sets the country of origin.
quantityinteger

Gets or sets the quantity.

  • int32
 containers

Gets or sets the shipment containers.

PropertyData TypeNotes
containerIdstring

Gets or sets the container ID.

packagingTypeenum

Gets or sets the packaging type.

  • Container
  • Pallet
containerTypestring

Gets or sets the container type.

capturedWeightnumber

Gets or sets the captured weight.

  • Decimal
weightUomenum

Gets or sets the weight UOM.

  • Lb
  • Oz
  • Kg
lengthnumber

Gets or sets the length.

  • Decimal
widthnumber

Gets or sets the width.

  • Decimal
heightnumber

Gets or sets the height.

  • Decimal
dimensionUomenum

Gets or sets the dimension UOM.

  • Inch
  • Cm
hazardousboolean

Gets or sets a value indicating whether the container is hazardous.

valuenumber

Gets or sets the value.

  • decimal
tenderedShipDateTimestring

Gets or sets the tendered ship date time.

  • date-time
estimatedDeliverDateTimestring

Gets or sets the estimated delivery date time.

  • date-time
actualDeliverDateTimestring

Gets or sets the actual delivery date time.

  • date-time
tareWeightnumber

Gets or sets the tare weight.

  • decimal


 containerLines

Gets or sets the container lines.

PropertyData TypeNotes
itemIdstring

Gets or sets the item ID.

This is the equivalent of the HostName field of ItemMaster.

shipmentLineNumberinteger

Gets or sets the shipment line number.

  • int32
quantitynumber

Gets or sets the quantity.

  • decimal
weightUomenum

Gets or sets the weight UOM.

  • Lb
  • Oz
  • Kg
itemVariantstringGets or sets the item variant.
itemCountryOfOriginstring

Gets or sets the item's country of origin.

itemUomstringGets or sets the item UOM.
weightPerUnitnumber

Gets or sets the weight per unit.

  • decimal
valuePerUnitnumber

Gets or sets the value per unit.

  • decimal
lengthnumber

Gets or sets the length.

  • decimal
widthnumber

Gets or sets the width.

  • decimal
heightnumber

Gets or sets the height.

  • decimal
dimensionUomenum

Gets or sets the dimension UOM.

  • Inch
  • Cm
batchstring

Gets or sets the batch name.

 transaction

Defines the shipment transaction data structure.

PropertyData TypeNotes
workflowTransactionCodestring

Gets or sets the workflow transaction code.

referenceNumstringGets or sets the reference number.
externalReferenceNumstring
Gets or sets the external reference number.
notestring

Gets or sets the note.

reasonCodestringGets or sets the reason code.
transactionTypestringGets or sets the transaction type.
businessTransactionTypeenum
  • PurchaseOrder
  • Shipment
  • TransportationTender
  • FreightInvoice


 tradingPartners

Gets or sets the list of business transaction partners.

PropertyData TypeNotes
name
stringGets or sets the name.
typeenum

Gets or sets the trading partner type.

  • Vendor
  • Carrier
isPrimarybooleanGets or sets a value indicating whether the business transaction partner is primary.
 Response
PropertyData TypeNotes
businessTransactionReferenceNumstring
businessTransactionStatusstring



Feedback

Submit feedback.