Shipment | Search

GET /api/v0/shipment/search

Request

Headers

Header Required Description
X-Auth-Token yes Authentication token

Query parameters

Each query parameter represents one filter parameter.

Parameter Type Description
mailbox string Mailbox (outbox, inbox) – default: outbox
senderTaxId string Sender Tax ID number
recipientTaxId string Recipient Tax ID number
contentType string Content type
sealed integer Is shipment sealed? (0, 1) – if 1, no further changes are available. Relevant to outbox only.
dateFrom string From date & time (format: Y-m-d H:i:s, example: 2005-08-15 15:52:01)
Example
curl --request GET 
  --url https://net.wings.rs/api/v0/shipment/search?mailbox=inbox&dateFrom=2020-06-18%2015%3A23%3A42 
  --header 'X-Auth-Token: <TOKEN>'

Response

Body

Parameter Type Description
id string Shipment ID (UUID)
senderEmailReplyTo string Sender Reply-To email
senderTaxId string Sender Tax ID number
recipientEmail string Recipient email
recipientEmailsCC array Recipient CC emails
recipientTaxId string Recipient Tax ID number
contentType string Content type
description string Description
sealed boolean Is shipment sealed? (if true, no further changes are available)
sent string Sent date (format: ISO-8601, example: 2005-08-15T15:52:01+00:00)
read string Read date (format: ISO-8601, example: 2005-08-15T15:52:01+00:00)
confirmed string Confirmation date (format: ISO-8601, example: 2005-08-15T15:52:01+00:00)
Example
{
  "data": [
    {
      "id": "0129995d-ae02-11ea-9818-0242ac190002",
      "senderEmailReplyTo": "office@wings.rs",
      "senderTaxId": "12345678",
      "recipientEmail": "office@example.com",
      "recipientEmailsCC": [
        "office1@example.com",
        "office2@example.com"
      ],
      "recipientTaxId": "87654321",
      "contentType": "DOC/INVOICE",
      "description": "Invoice 001",
      "sealed": true,
      "sent": "2020-06-14T05:49:24+00:00",
      "read": "2020-06-14T21:27:10+00:00",
      "confirmed": "2020-06-14T21:29:05+00:00"
    },
    {
      "id": "240dd5c6-a9e1-11ea-98f0-0242ac190002",
      "senderEmailReplyTo": "office@wings.rs",
      "senderTaxId": "12345678",
      "recipientEmail": "office@example.com",
      "recipientEmailsCC": null,
      "recipientTaxId": "87654321",
      "contentType": "DOC/INVOICE",
      "description": "Invoice 002",
      "sealed": true,
      "sent": "2020-06-14T11:39:16+00:00",
      "read": null,
      "confirmed": null
    }
  ]
}