Get shipment collection

Time Status User Agent
Make a request to see history.

URL Expired

The URL for this request expired after 30 days.

``200 The requested shipment collection

object

actionUrlCancel

array

actionUrlPack

array

actionUrlReceive

array

actionUrlShip

array

actionUrlTransfer

array

actionUrlUnpack

array

cancelDate

array

carrierPartyUrl

array

connectionRelationUrlList

array

consolidatedItemList

array

contentList

array

countPackages

array

createdDate

array

createdUserLoginId

array

destinationFacilityUrl

array

facilityUrlPack

array

lastUpdatedDate

array

lastUpdatedUserLoginId

array

originFacilityUrl

array

packDate

array

packageUrlList

array

primaryOrderUrl

array

primaryReturnUrl

array

privateNotes

array

Public notes field from the user interface. Read and write.

publicNotes

array

Public notes field from the user interface. Read and write.

receiveDate

array

receiveDateEstimated

array

shipDate

array

shipDateEstimated

array

shipmentId

array

shipmentIdUser

array

shipmentItemList

array

shipmentTypeId

array

shipmentUrl

array

statusId

array

trackingCode

array

transferList

array

unpackDate

array

userFieldDataList

array

Array of values for user defined fields on the Shipment. Each value in the array is an object with the keys attrName and attrValue. The attrName is the internal name of a user defined field as listed in the customization service. Other systems integrating with Finale can store information in the userFieldDataList. Other systems should prefix their attrName with the string "integration_" to avoid conflicting with keys created by Finale. The attrValue is the string representation of the value for this Shipment for the user defined field. Both are limited to 255 Unicode characters. To make tracking and syncing changes to other systems, the field attrValueLastUpdatedDate be set instead of the field attrValue. When attrValue is not set and attrValueLastUpdatedDate is set to true, then the server sets the value to same value as the lastUpdatedDate. This allows easy searching for entities that have been updated since the last time they were synced to an external system.

Example:

  userFieldDataList:[ {attrName:'user_10000', attrValue:'7/2/2010'}, {attrName:'integration_10004', attrValue:'3/12/2011'} ]

Base URL

https://app.finaleinventory.com/account/api/shipment

xxxxxxxxxx

curl --request GET \

--url https://app.finaleinventory.com/account/api/shipment \

--header 'accept: application/json' \

--header 'authorization: Basic ••••'
xxxxxxxxxx

{

"actionUrlCancel": [],

"actionUrlPack": [],

"actionUrlReceive": [],

"actionUrlShip": [],

"actionUrlTransfer": [],

"actionUrlUnpack": [],

"cancelDate": [],

"carrierPartyUrl": [],

"connectionRelationUrlList": [],

"consolidatedItemList": [],

"contentList": [],

"countPackages": [],

"createdDate": [],

"createdUserLoginId": [],

"destinationFacilityUrl": [],

"facilityUrlPack": [],

"lastUpdatedDate": [],

"lastUpdatedUserLoginId": [],

"originFacilityUrl": [],

"packDate": [],

"packageUrlList": [],

"primaryOrderUrl": [],

"primaryReturnUrl": [],

"privateNotes": [],

"publicNotes": [],

"receiveDate": [],

"receiveDateEstimated": [],

"shipDate": [],

"shipDateEstimated": [],

"shipmentId": [],

"shipmentIdUser": [],

"shipmentItemList": [],

"shipmentTypeId": [],

"shipmentUrl": [],

"statusId": [],

"trackingCode": [],

"transferList": [],

"unpackDate": [],

"userFieldDataList": []

}