Changed shipments report

POST /openapi/Report/GetShipmentReport — TMS API · Tracking and Status

Returns shipments changed after the changedDate in a paginated manner. Used for periodic synchronization (fetching changes).

  • format: JSON (default) or CSV. Response is text/csv for CSV.
  • Pagination: pageNumber (starts at 1), pageSize (maximum 50; larger values are reduced to 50).
  • Pagination info is returned as JSON in the X-Pagination response header: TotalCount, PageSize, CurrentPage, TotalPages, HasNext, HasPrevious.
  • The format field is mandatory; returns 400 if a value other than JSON or CSV is given.

İstek gövdesi

  • format (string, zorunlu): Response format.
  • pageSize (integer): Page size; values over 50 are reduced to 50.
  • clientCode (string, zorunlu): Organization code.
  • pageNumber (integer): Page number.
  • accountCode (string, zorunlu): Account code.
  • changedDate (string<date-time>, zorunlu): Returns shipments changed after this date.
  • shipmentStatusId (integer): Only shipments with this TMS status ID (e.g. 24 label printed, 28 delivered).

Yanıtlar

  • 200: Shipment list
  • 400: Validation error or invalid format
  • 401: Token missing, invalid, or expired (bodyless response).

200 yanıt alanları

  • desi (string): Volume (desi).
  • cityCode (string): Arrival city.
  • townCode (string): Arrival district.
  • shipmentId (integer): TMS shipment ID.
  • carrierCode (string): Carrier code.
  • orderNumber (string): Order number.
  • packingDate (string<date-time>): Label printing time.
  • shipmentKey (string): ShipmentKey.
  • districtCode (string): Arrival neighborhood.
  • deliveredDate (string<date-time>): Delivery time.
  • firstReadingDate (string<date-time>): Carrier's first scan (transfer start) time.
  • shipmentStatusCode (string): Current TMS status code.