Fetch shipments and shipment data

GET REST API request for merchants, that returns shipments and shipments data.

Parameter search will find shipment by shipment id or multiple shipments if order id is used as a search parameter.

Parameter statusGroup will filter orders per order status group. Three values for status group parameter are SG_FOR_PACKAGING, SG_SHIPMENT_ON_DELIVERY and SG_COMPLETED.

One of the parameters, search or statusGroup, must be specified in the request. If none of them are specified, response will be 4xx.

The other 2 parameters are pageSize and pageNum are used for pagination. The default value for page size is 100. The default value for page number is 0. The maximum allowed page size is 100. If page size specified in the request is bigger than 100, the default page size of 100 will be used.

Request

HTTP Method

PUT

URL

Stage

https://api.stage.ananastest.com/order/api/v1/merchant-integration/outbound-orders/shipments

Production

https://api.ananas.rs/order/api/v1/merchant-integration/outbound-orders/shipments

HTTP Headers

Header name	Header value
Authorization	Bearer {access_token}

URL Parameters

Parameter name	Parameter description
search	Refers to the id of an order or shipment
statusGroup	Status group of an order. Can have three values: SG_FOR_PACKAGING, SG_SHIPMENT_ON_DELIVERY, and SG_COMPLETED
warehouseIds	Referes to unique merchant address identifiers
pageNum	Page number
pageSize	Number of orders shown by page

Examples:

https://api.stage.ananastest.com/order/api/v1/merchant-integration/outbound-orders/shipments?search=TV4YK-OLZRU-DS-1

https://api.stage.ananastest.com/order/api/v1/merchant-integration/outbound-orders/shipments?statusGroup=SG_FOR_PACKAGING

Response

Response is a collection of shipment details

JSON

Click to copy

Success!

{
  "content": [
    {
      "orderId": "H7SRK-Z2IAO",
      "suborderId": "H7SRK-Z2IAO-DS-1",
      "status": "READY_FOR_COLLECTION",
      "statusSubgroup": "SSG_TRANSPORT_INITIATED",
      "totalPrice": 5000.00,
      "packedQuantity": 1,
      "confirmedQuantity": 1,
      "warehouseName": "CEZAR PLUS d.o.o. CEZAR Skladište",
      "warehouseId": 2096,
      "carrierName": "City Express",
      "type": "Standard",
      "createdDate": "2023-11-07T00:10:32.779083Z",
      "items": [
        {
          "packedQuantity": 1,
          "confirmedQuantity": 1,
          "merchantInventoryId": 1777104,
          "unitPrice": 5000.00,
          "totalPrice": 5000.00,
          "orderedQuantity": 1,
          "productName": "Slušalice05",
          "productEan": "8606108800409",
          "productSku": "Slušalice05",
          "productSpecifications": "{\"attributes\": []}"
        }
      ]
    },
    {
      "orderId": "XLOGV-0RTNL",
      "suborderId": "XLOGV-0RTNL-DS-1",
      "status": "READY_FOR_COLLECTION",
      "statusSubgroup": "SSG_TRANSPORT_INITIATED",
      "totalPrice": 20000.00,
      "packedQuantity": 2,
      "confirmedQuantity": 2,
      "warehouseName": "Test3335 WH1",
      "warehouseId": 1853,
      "carrierName": "City Express",
      "type": "Standard",
      "createdDate": "2023-11-01T14:47:41.616218Z",
      "items": [
        {
          "packedQuantity": 2,
          "confirmedQuantity": 2,
          "merchantInventoryId": 1777105,
          "unitPrice": 10000.00,
          "totalPrice": 20000.00,
          "orderedQuantity": 2,
          "productName": "Slušalice10",
          "productEan": "6995019102118",
          "productSku": "Slušalice10",
          "productSpecifications": "{\"attributes\": []}"
        }
      ]
    }
  ],
  "pageable": {
    "sort": {
      "empty": false,
      "unsorted": false,
      "sorted": true
    },
    "offset": 0,
    "pageNumber": 0,
    "pageSize": 100,
    "paged": true,
    "unpaged": false
  },
  "last": true,
  "totalPages": 1,
  "totalElements": 2,
  "first": true,
  "size": 100,
  "number": 0,
  "sort": {
    "empty": false,
    "unsorted": false,
    "sorted": true
  },
  "numberOfElements": 2,
  "empty": false
}