# Shipment tracking

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /shipment:
    get:
      summary: Shipment tracking
      deprecated: false
      description: ''
      tags:
        - API Methods/Shipment
        - Shipment
      parameters:
        - name: ShipmentNumbers
          in: query
          description: ShipmentNumbers
          required: false
          schema:
            maxItems: 50
            type: array
            items:
              type: string
        - name: InvoiceNumbers
          in: query
          description: InvoiceNumbers
          required: false
          schema:
            maxItems: 50
            type: array
            items:
              type: string
        - name: CustomerReferences
          in: query
          description: CustomerReferences
          required: false
          schema:
            maxItems: 50
            type: array
            items:
              type: string
        - name: VariableSymbols
          in: query
          description: VariableSymbols
          required: false
          schema:
            maxItems: 50
            type: array
            items:
              type: string
        - name: DateFrom
          in: query
          description: DateFrom
          required: false
          schema:
            type: string
            format: date-time
        - name: DateTo
          in: query
          description: DateTo
          required: false
          schema:
            type: string
            format: date-time
        - name: ShipmentStates
          in: query
          description: ShipmentStates
          required: false
          schema: &ref_0
            $ref: >-
              #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates
        - name: Limit
          in: query
          description: ''
          required: true
          schema:
            maximum: 1000
            minimum: 1
            type: integer
            format: int32
        - name: Offset
          in: query
          description: ''
          required: true
          schema:
            maximum: 2147483647
            minimum: 0
            type: integer
            format: int32
        - name: Accept-Language
          in: header
          description: 'Language specification, default language: cs-CZ'
          required: false
          example: ''
          schema:
            $ref: '#/components/schemas/AcceptLanguageSchema'
        - name: X-Correlation-ID
          in: header
          description: Correlation Id of request
          required: false
          example: ''
          schema:
            $ref: '#/components/schemas/XCorrelationIdSchema'
        - name: X-LogLevel
          in: header
          description: The forced log level
          required: false
          example: ''
          schema:
            $ref: '#/components/schemas/XLogLevelSchema'
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: >-
                    #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel
          headers:
            X-Correlation-ID:
              description: Correlation Id of request otherwise id of response
              schema:
                $ref: '#/components/schemas/XCorrelationIdSchema'
            X-Paging-Total-Items-Count:
              description: Total items in result
              schema:
                $ref: '#/components/schemas/XPagingSchema'
            X-Paging-Offset:
              description: Paging offset
              schema:
                $ref: '#/components/schemas/XPagingSchema'
            X-Paging-Limit:
              description: Page size
              schema:
                $ref: '#/components/schemas/XPagingSchema'
          x-apidog-name: OK
        '400':
          description: BadRequest
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Bad Request
        '404':
          description: NotFound
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Record Not Found
        '500':
          description: InternalServerError
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Server Error
        '503':
          description: ServiceUnavailable
          content:
            application/problem+json:
              schema:
                type: object
                properties: {}
                x-apidog-orders: []
                x-apidog-ignore-properties: []
          headers: {}
          x-apidog-name: Service Unavailable
      security:
        - Bearer: []
          x-apidog:
            required: true
            schemeGroups:
              - id: zMDuf246PuaUEGdGwIGbj
                schemeIds:
                  - Bearer
            use:
              id: zMDuf246PuaUEGdGwIGbj
      x-apidog-folder: API Methods/Shipment
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/800807/apis/api-13601484-run
components:
  schemas:
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentStates:
      enum:
        - None
        - Undelivered
        - Delivered
        - PickedUpFromSender
        - DeliveredToPickupPoint
        - OutForDelivery
        - NotDelivered
        - CodPaidDate
        - BackToSender
        - Rejected
        - DataShipment
        - Active
        - Canceled
        - Dormant
      type: string
      description: ShipmentStates
      x-apidog-folder: ''
    AcceptLanguageSchema:
      type: string
      description: Accept-Language header schema
      x-apidog-folder: ''
    XCorrelationIdSchema:
      type: string
      description: X-Correlation-ID header schema
      x-apidog-folder: ''
    XLogLevelSchema:
      enum:
        - Trace
        - Debug
        - Information
        - Warning
        - Error
        - Critical
      type: string
      description: X-LogLevel header schema
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentModel:
      type: object
      properties:
        shipmentNumber:
          type: string
          description: ShipmentNumber
          nullable: true
        productType:
          type: string
          description: ProductType
          nullable: true
        productTypeChanged:
          type: boolean
          description: True = productType was changed
        note:
          type: string
          description: Note
          nullable: true
        depot:
          type: string
          description: Depot
          nullable: true
        integratorId:
          type: integer
          description: IntegratorId
          format: int32
          nullable: true
        lastUpdateDate:
          type: string
          description: Last update date
          format: date-time
          nullable: true
        shipmentState: *ref_0
        shipmentSet:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel
            - &ref_1
              $ref: '#/components/schemas/EmptyNullableObject'
        sender:
          oneOf:
            - &ref_2
              $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel
            - *ref_1
        recipient:
          oneOf:
            - *ref_2
            - *ref_1
        specificDelivery:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel
            - *ref_1
        externalNumbers:
          type: array
          items:
            $ref: >-
              #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel
          description: ExternalNumbers
          nullable: true
        services:
          type: array
          items:
            $ref: >-
              #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel
          description: Services
          nullable: true
        trackAndTrace:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel
            - *ref_1
        shipmentWeightInfo:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel
            - *ref_1
        paymentInfo:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel
            - *ref_1
        deliveryFeature:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel
            - *ref_1
        backShipmentFeature:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel
            - *ref_1
        dormantShipmentFeature:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel
            - *ref_1
        accessPointFeature:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel
            - *ref_1
        routingFeature:
          oneOf:
            - $ref: >-
                #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.RoutingFeatureModel
            - *ref_1
      additionalProperties: false
      description: ShipmentModel
      x-apidog-orders:
        - shipmentNumber
        - productType
        - productTypeChanged
        - note
        - depot
        - integratorId
        - lastUpdateDate
        - shipmentState
        - shipmentSet
        - sender
        - recipient
        - specificDelivery
        - externalNumbers
        - services
        - trackAndTrace
        - shipmentWeightInfo
        - paymentInfo
        - deliveryFeature
        - backShipmentFeature
        - dormantShipmentFeature
        - accessPointFeature
        - routingFeature
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.RoutingFeatureModel:
      type: object
      properties:
        routingNumber:
          type: string
          description: Routing number
          nullable: true
      additionalProperties: false
      description: RoutingFeatureModel
      x-apidog-orders:
        - routingNumber
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.AccessPointFeatureModel:
      type: object
      properties:
        accessPointDaysInStorage:
          type: integer
          description: Number of days at the access point
          format: int32
          nullable: true
        accessPointDaysInStorageRemain:
          type: integer
          description: Number of remaining days at the access point
          format: int32
          nullable: true
        accessPointHoursInStorageRemain:
          type: integer
          description: Number of remaining hours at the access point
          format: int32
          nullable: true
      additionalProperties: false
      description: Access point feature model
      x-apidog-orders:
        - accessPointDaysInStorage
        - accessPointDaysInStorageRemain
        - accessPointHoursInStorageRemain
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.DormantShipmentFeatureModel:
      type: object
      properties:
        dormantShipmentNumber:
          type: string
          description: DormantShipmentNumber
          nullable: true
        dormantShipmentNumberActive:
          type: boolean
          description: DormantShipmentNumberActive
          nullable: true
      additionalProperties: false
      description: DormantShipmentFeatureModel
      x-apidog-orders:
        - dormantShipmentNumber
        - dormantShipmentNumberActive
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.BackShipmentFeatureModel:
      type: object
      properties:
        backDate:
          type: string
          description: Back date
          format: date-time
          nullable: true
      additionalProperties: false
      description: BackShipmentFeatureModel
      x-apidog-orders:
        - backDate
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentDeliveryFeatureModel:
      type: object
      properties:
        loadDate:
          type: string
          description: Date of loading shipment for delivery.
          format: date-time
          nullable: true
        delivDate:
          type: string
          description: Delivery date
          format: date-time
          nullable: true
        delivPerson:
          type: string
          description: Delivery person
          nullable: true
        notDelivDate:
          type: string
          description: Not delivery date
          format: date-time
          nullable: true
        outDepDate:
          type: string
          description: Out dep date
          format: date-time
          nullable: true
        hubDate:
          type: string
          description: Hub date
          format: date-time
          nullable: true
        deliveryToAccessPoint:
          type: boolean
          description: DeliveryToAccessPoint
      additionalProperties: false
      description: ShipmentDeliveryFeatureModel
      x-apidog-orders:
        - loadDate
        - delivDate
        - delivPerson
        - notDelivDate
        - outDepDate
        - hubDate
        - deliveryToAccessPoint
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentPaymentFeatureModel:
      type: object
      properties:
        paidByCard:
          type: boolean
        codPaidDate:
          type: string
          format: date-time
          nullable: true
        invoiceNumber:
          type: string
          nullable: true
        bankAccount:
          type: string
          nullable: true
        bankCode:
          type: string
          nullable: true
        codBankStatementDate:
          type: string
          format: date-time
          nullable: true
        codCurrency:
          type: string
          nullable: true
        codPaymentAccDate:
          type: string
          format: date-time
          nullable: true
        codPrice:
          type: number
          format: double
          nullable: true
        codVariableSymbol:
          type: string
          nullable: true
        specificSymbol:
          type: string
          nullable: true
      additionalProperties: false
      description: ShipmentPaymentFeatureModel
      x-apidog-orders:
        - paidByCard
        - codPaidDate
        - invoiceNumber
        - bankAccount
        - bankCode
        - codBankStatementDate
        - codCurrency
        - codPaymentAccDate
        - codPrice
        - codVariableSymbol
        - specificSymbol
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentWeightFeatureModel:
      type: object
      properties:
        weight:
          type: number
          description: Gets or sets the weight.
          format: double
          nullable: true
        weighedDate:
          type: string
          description: Weighed date
          format: date-time
          nullable: true
      additionalProperties: false
      description: ShipmentWeightFeatureModel
      x-apidog-orders:
        - weight
        - weighedDate
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceModel:
      type: object
      properties:
        externalShipmentId:
          type: string
          description: External shipment Id
          nullable: true
        partnerUrl:
          type: string
          description: Partner track and trace URL
          nullable: true
        lastEventCode:
          type: string
          description: Last event code
          nullable: true
        lastEventDate:
          type: string
          description: Last event date
          format: date-time
          nullable: true
        lastEventName:
          type: string
          description: Last event name
          nullable: true
        events:
          type: array
          items:
            $ref: >-
              #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel
          description: Track and trace events
          nullable: true
      additionalProperties: false
      description: Track and trace
      x-apidog-orders:
        - externalShipmentId
        - partnerUrl
        - lastEventCode
        - lastEventDate
        - lastEventName
        - events
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.TrackAndTraceItemModel:
      type: object
      properties:
        statusId:
          type: integer
          description: Status id
          format: int32
        code:
          type: string
          description: Event code
          nullable: true
        phase:
          type: string
          description: Event phase
          nullable: true
        group:
          type: string
          description: Event group
          nullable: true
        eventDate:
          type: string
          description: Event date
          format: date-time
        name:
          type: string
          description: Status name from codelist
          nullable: true
        gpsLatitude:
          type: number
          description: Latitude
          format: double
          nullable: true
        gpsLongitude:
          type: number
          description: Longitude
          format: double
          nullable: true
      additionalProperties: false
      description: TrackAndTraceItemModel
      x-apidog-orders:
        - statusId
        - code
        - phase
        - group
        - eventDate
        - name
        - gpsLatitude
        - gpsLongitude
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ServiceModel:
      type: object
      properties:
        additionalParameters:
          type: array
          items:
            $ref: >-
              #/components/schemas/Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel
          description: AdditionalParameters
          nullable: true
        code:
          type: string
          description: Code
          nullable: true
        price:
          type: number
          description: Price
          format: double
          nullable: true
        priceCurrency:
          type: string
          description: PriceCurrency
          nullable: true
      additionalProperties: false
      description: ServiceModel
      x-apidog-orders:
        - additionalParameters
        - code
        - price
        - priceCurrency
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.AdditionalParameterModel:
      type: object
      properties:
        type:
          type: string
          description: Type
          nullable: true
        reference:
          type: string
          description: Reference
          nullable: true
      additionalProperties: false
      description: AdditionalParameterModel
      x-apidog-orders:
        - type
        - reference
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ExternalNumberModel:
      type: object
      properties:
        externalNumber:
          type: string
          description: ExternalNumber
          nullable: true
        code:
          type: string
          description: Code
          nullable: true
      additionalProperties: false
      description: ExternalNumberModel
      x-apidog-orders:
        - externalNumber
        - code
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.SpecificDeliveryFeatureModel:
      type: object
      properties:
        specificDeliveryDate:
          type: string
          description: SpecificDeliveryDate
          format: date-time
          nullable: true
        specificDeliveryTimeFrom:
          type: string
          description: SpecificDeliveryTimeFrom
          format: date-span
          nullable: true
        specificDeliveryTimeTo:
          type: string
          description: SpecificDeliveryTimeTo
          format: date-span
          nullable: true
        specificTakeDate:
          type: string
          description: SpecificTakeDate
          format: date-time
          nullable: true
        specificTakeTimeFrom:
          type: string
          description: SpecificTakeTimeFrom
          format: date-span
          nullable: true
        specificTakeTimeTo:
          type: string
          description: SpecificTakeTimeTo
          format: date-span
          nullable: true
        accessPointCode:
          type: string
          description: ParcelShopCode
          nullable: true
      additionalProperties: false
      description: SpecificDeliveryFeatureModel
      x-apidog-orders:
        - specificDeliveryDate
        - specificDeliveryTimeFrom
        - specificDeliveryTimeTo
        - specificTakeDate
        - specificTakeTimeFrom
        - specificTakeTimeTo
        - accessPointCode
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentAddressModel:
      type: object
      properties:
        name:
          type: string
          description: Name
          nullable: true
        name2:
          type: string
          description: Name2
          nullable: true
        street:
          type: string
          description: Street
          nullable: true
        city:
          type: string
          description: City
          nullable: true
        zipCode:
          type: string
          description: ZipCode
          nullable: true
        country:
          type: string
          description: Country
          nullable: true
        contact:
          type: string
          description: Contact
          nullable: true
        phone:
          type: string
          description: Phone
          nullable: true
        email:
          type: string
          description: Email
          nullable: true
      additionalProperties: false
      description: AddressBaseModel
      x-apidog-orders:
        - name
        - name2
        - street
        - city
        - zipCode
        - country
        - contact
        - phone
        - email
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
    EmptyNullableObject:
      description: Injected nullable object
      type: 'null'
      x-apidog-folder: ''
    Eps.Api.MyApi2.Web.Models.Shipment.ShipmentSetFeatureModel:
      type: object
      properties:
        masterShipmentNumber:
          type: string
          description: MasterShipmentNumber
          nullable: true
        shipmentsInSet:
          type: integer
          description: ShipmentsInSet
          format: int32
        shipmentInSetNumber:
          type: integer
          description: ShipmentInSetNumber
          format: int32
      additionalProperties: false
      description: ShipmentSetFeatureModel
      x-apidog-orders:
        - masterShipmentNumber
        - shipmentsInSet
        - shipmentInSetNumber
      x-apidog-ignore-properties: []
      x-apidog-folder: ''
  securitySchemes:
    oauth2:
      type: apikey
      description: Get access token from authentication server.
      name: Authorization
      in: header
    Bearer:
      type: jwt
      description: >-
        JWT Authorization header using the Bearer scheme. Example:
        "Authorization: Bearer {token}"
      scheme: bearer
      bearerFormat: JWT
servers: []
security:
  - Bearer: []
    x-apidog:
      schemeGroups:
        - id: Y1Pl_6gJhwt22zSpU8-70
          schemeIds:
            - Bearer
      required: true
      use:
        id: Y1Pl_6gJhwt22zSpU8-70
      scopes:
        Y1Pl_6gJhwt22zSpU8-70:
          Bearer: []

```