Enjovia API
GET /packages/outstanding/postal
Bearer auth

Returns a paginated list of postal packages with status 'outstanding'. Includes store, vouchers, packaging option, and delivery method details. Requires view_orders permission.

Headers

  • Account-ID string(uuid) Required

    Account ID - Can be found on the Dashboard under Settings → API Tokens

Query parameters

  • page integer

    Default value is 1.

  • per_page integer

    Default value is 15.

  • sort string

    Sort packages by field. Use '-' prefix for descending order. Available fields: created_at Default: -created_at

  • filter[store.id][] array[string(uuid)]

    Filter by store UUIDs

Responses

  • 200 application/json

    List of outstanding postal packages with pagination

    Hide response attributes Show response attributes object
    • data array[object]

      Postal package details for third-party fulfilment partners

      Hide data attributes Show data attributes object
      • id string(uuid)

        Unique identifier for the package

      • packaging_option_id string(uuid)

        UUID of the packaging option

      • packaging_option_name string

        Name of the packaging option at time of order

      • delivery_method_id string(uuid)

        UUID of the delivery method

      • delivery_method_name string

        Name of the delivery method at time of order

      • delivery_address object

        Delivery address details

        Hide delivery_address attributes Show delivery_address attributes object
        • name string
        • address object
          Hide address attributes Show address attributes object
          • line1 string
          • line2 string | null
          • city string
          • state string | null
          • postal_code string
          • country string
      • created_at string(date-time)

        Timestamp when the package was created

      • store object

        Store the package belongs to

        Hide store attributes Show store attributes object
        • id string(uuid)
        • name string
      • vouchers array[object]

        Vouchers included in this package

        Hide vouchers attributes Show vouchers attributes object
        • reference string

          Voucher reference code

        • pdf_url string(uri)

          URL to download the voucher PDF

    • links object
      Hide links attributes Show links attributes object
      • first string(uri)
      • last string(uri)
      • prev string(uri) | null
      • next string(uri) | null
    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • from integer
      • last_page integer
      • path string
      • per_page integer
      • to integer
      • total integer
  • 401

    Unauthorized

  • 403

    Forbidden - Requires view_orders permission

GET /packages/outstanding/postal 
curl \
 --request GET 'https://api.gb.enjovia.app/packages/outstanding/postal' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Account-ID: string"
Response examples (200) 
{
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "packaging_option_id": "456e7890-e89b-12d3-a456-426614174001",
      "packaging_option_name": "Gift Box",
      "delivery_method_id": "789abcde-e89b-12d3-a456-426614174002",
      "delivery_method_name": "Royal Mail Tracked",
      "delivery_address": {
        "name": "John Doe",
        "address": {
          "line1": "123 Main Street",
          "line2": "Apt 4B",
          "city": "London",
          "state": "Greater London",
          "postal_code": "SW1A 1AA",
          "country": "GB"
        }
      },
      "created_at": "2024-01-15T14:30:00Z",
      "store": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "name": "Acme Gift Shop"
      },
      "vouchers": [
        {
          "reference": "ABC12-X9",
          "pdf_url": "https://api.example.com/vouchers/abc12345-e89b-12d3-a456-426614174000/pdf"
        }
      ]
    }
  ],
  "links": {
    "first": "https://example.com",
    "last": "https://example.com",
    "prev": "https://example.com",
    "next": "https://example.com"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 5,
    "path": "/packages/outstanding/postal",
    "per_page": 20,
    "to": 20,
    "total": 100
  }
}