Get carrier billing suborders

GET REST API endpoint intended for carrier-biller-integration. This API allows carrier billers to retrieve all suborders associated with the merchant’s carrier_biller configuration, including financial and shipping cost details required for billing.

The endpoint is structurally similar to/api/v1/merchant-integration/outbound-orders, but exposes a simplified and purpose-specific payload. Only essential information relevant to carrier billing is returned.

Authentication uses the ClientCredentials OAuth flow. From the provided access token, the system resolves merchant_id. Using merchant_id, the merchant's PIB is retrieved and used to determine the associated carrier_biller. Returned data is limited to suborders belonging to that carrier_biller.

This API supports several filtering options via query parameters. BothdeliveredDateFrom and deliveredDateTo are required parameters. Suborders are returned only if they satisfy all filters.

Request

HTTP Method

GET

URL

Stage

https://api.qa2.ananastest.com/order/api/v1/carrier-biller-integration/outbound-orders

Production

https://api.ananas.rs/order/api/v1/carrier-biller-integration/outbound-orders

HTTP Headers

Header name	Header value
Authorization	Bearer {access_token}

Query Parameters

Parameter name	Description
createdDateFrom	Optional. Filters by created date (from)
createdDateTo	Optional. Filters by created date (to)
deliveredDateFrom	Required. Delivered date (from)
deliveredDateTo	Required. Delivered date (to)
suborderIds	Optional. Filter by multiple suborder IDs
orderId	Optional. Filter by order ID
size	Optional. Must be ≥ 0 and ≤ 500

Validation Rules

deliveredDateFrom and deliveredDateTo must not be null.
deliveredDateTo must not be before deliveredDateFrom.
Date range must not exceed configured max, that is 3 months.
If createdDateFrom and createdDateTo are provided, same validations apply as for deliveredDate.
size must be ≥ 1 and ≤ 500.
Carrier_biller TIN must match merchant PIB.

Response

Response returns all suborders associated with the resolved carrier_biller, including shipping and fee details required for billing reports.

Fields

Field name	Type	Description
suborderId	String	User-friendly suborder ID
orderId	String	User-friendly order ID
carrierName	String	Carrier billing provider name
createdDate	LocalDateTime	Created date
deliveredDate	LocalDateTime	Delivered date
shippingInvoiceId	String	Invoice ID for shipping billing
isLegalEntityBuyer	Boolean	Is buyer a legal entity
legalEntityBuyer	Object	Buyer legal entity info
shippingCostDetails	Object	Shipping cost breakdown
suborderFeeDetails	List	List of fee components

Example Request

GET https://api.qa2.ananastest.com/order/api/v1/carrier-biller-integration/outbound-orders?deliveredDateFrom=2025-04-02T00:10:00.0000000Z&deliveredDateTo=2025-06-08T10:10:00.0000000Z Authorization: Bearer ACCESS_TOKEN

Example Response


[
  {
    "suborderId": "L9HPA-LWX7G-DS-1",
    "orderId": "L9HPA-LWX7G",
    "carrierName": "Ananas Express MK",
    "createdDate": "2025-10-02T10:51:48.101273Z",
    "deliveredDate": "2025-10-02T10:54:28.591448Z",
    "shippingInvoiceId": "25260227412",
    "isLegalEntityBuyer": false,
    "legalEntityBuyer": {
      "buyerTin": null,
      "buyerName": null
    },
    "shippingCostDetails": {
      "shippingCost": 700.0,
      "shippingCostWithoutVat": 593.22,
      "shippingCostVat": 18,
      "shippingCostBasePrice": 700.0,
      "shippingCostBasePriceWithoutVat": 593.22
    },
    "suborderFeeDetails": []
  }
]