API

API endpoints > shipments > newsince > get

This endpoint requests all shipments that are imported in the system since the given date and time. Each request will return 25 shipments at most to keep the load within reasonable metrics.
If the list is longer than 25 items, a second request is done and the start item is set to 26, etc. at a rate of 1 request per second at most.

Notes

The maximum time back in time is 2 days. So it is best to check at least once a day.

Add the required startNumber/iso3339Date to the end of the URL to identify the object for the request.

JSON data structure

No data is expected for this operation.

JSON reply data

  • ShipmentCountInteger numberAlways returnedMinimum value: 1The number of shipments reported in this list. If ShipmentCount is less than 25, it means this is the last possible shipment list, further requests are not needed.
  • ShipmentsArray of objectsAlways returnedMinimum array items: 1Array of shipments
    • CarrierIdInteger numberAlways returnedMinimum value: 1The id of the carrier
    • ClientReferenceStringAlways returnedMinimum length: 1The client reference code for the order/shipment
    • ColliInteger numberAlways returnedMinimum value: 1The number of colli's
    • ImportDateRFC3339 datetimeAlways returnedThe date this shipment was received
    • Note1StringOptional shipment note, might be used for extra information.
    • Note2StringOptional shipment note, might be used for extra information.
    • OptionIdInteger numberAlways returnedMinimum value: 1Extra option id for the carrier
    • ServiceIdInteger numberAlways returnedMinimum value: 1The correct service id for the carrier
    • ShipmentIdInteger numberAlways returnedMinimum value: 1The internal shipment id
    • ExtraServicesArray of objectsAlways returnedAny extra "stackable" services (like servicepoints, insurance etc)
      • ServiceIdInteger numberAlways returnedMinimum value: 1The service id (see service list for known id)
      • ValueStringAlways returnedMinimum length: 1The service value (can be comma separated list)
    • RecipientsublistAlways returnedAddress information
      • CityStringAlways returnedMinimum length: 2, maximum length: 50Cityname
      • CompanyNameStringMinimum length: 1, maximum length: 100Optional company name
      • CountryCountryAlways returnedMinimum length: 2, maximum length: 3Country, iso3 format
      • EmailE-mailMinimum length: 2, maximum length: 100Email address (required for some carriers)
      • HouseNumberInteger numberMinimum value: 1Housenumber
      • NameStringAlways returnedMinimum length: 1, maximum length: 100Person name
      • NeighborhoodStringMaximum length: 50Neighborhood/community
      • NumberExtensionStringHousenumber extension (floor, a, etc.)
      • PhoneStringMinimum length: 5, maximum length: 20Phone number (required for some carriers)
      • PostalCodeStringAlways returnedMinimum length: 3, maximum length: 15Postalcode
      • StateStringMinimum length: 2, maximum length: 50State/province name (required in some countries)
      • Streetname1StringAlways returnedMinimum length: 3, maximum length: 100Street name line 1 (can include housenumber if not defined in HouseNumber)
      • Streetname2StringMaximum length: 100Street name line 2, not supported by all carriers!
    • ShipmentItemsArray of objectsAlways returnedAny items that are registered in this shipment. Mostly used for customs
      • ArticleNumberStringMinimum length: 1The item EAN, SKU, UPC etc.
      • DescriptionStringMinimum length: 3, maximum length: 100Item name/description
      • DimensionsStringDimensions of the item (length X width x height)
      • HSCodeStringThe custsoms HS code for this item
      • PriceReal numberThe price, no currency code is added
      • QuantityInteger numberMinimum value: 1The number of items
      • WeightInteger numberThe weight of the item in gramms

GET/shipments/newsince/:startNumber/:iso3339Date
POST/shipments/
POST/shipments/sendupdate/
POST/shipments/addstatusline/
PATCH/shipments/