Changelog
Back to All
added

Extra Cover for Australian Senders

5 months ago by Phyu Phyu Thet

📘

Executive Summary

This API change introduces a new field that allows you to add Sendle Extra Cover for an order. At the moment, Sendle Extra Cover can only be added for orders from Australia (this includes domestic and international orders).

See more about Sendle Extra Cover policy in our help centre article.

Changes

  • When creating orders from Australia, you can add Sendle Extra Cover for the order in the Create an order endpoint.

The new fields

  • cover:
    • total_cover:
      • amount: value for the Sendle Extra Cover ( in AUD )

Examples

Create an Order request

{
  "cover": {
    "total_cover": {
      "amount": 110
    }
  },
  "first_mile_option": "pickup",
  "description": "test",
  "weight": {
    "value": "0.2",
    "units": "kg"
  },
  "volume": {
    "value": "0.001",
    "units": "m3"
  },
  "customer_reference": "test",
  "metadata": {
    "your_data": "123"
  },
  "sender": {
   ...
  },
  "receiver": {
   ...
  }
}

Create an Order response

  • cover and cover_tax will be included in price_breakdown in the API response.
{
  "order_id": "f5233746-71d4-4b05-bf63-56f4abaed5f6",
  "state": "Pickup",
  "order_url": "https://api.sendle.com/api/orders/f5233746-71d4-4b05-bf63-56f4abaed5f6",
  "sendle_reference": "SNFJJ3",
 ...
    "price": {
        "gross": {
            "amount": 9.42,
            "currency": "AUD"
        },
        "net": {
            "amount": 8.56,
            "currency": "AUD"
        },
        "tax": {
            "amount": 0.86,
            "currency": "AUD"
        }
    },
    "packaging_type": "box",
    "expires_at": "2024-08-01T03:29:01.978Z",
    "price_breakdown": {
        "base": {
            "amount": 6.23,
            "currency": "AUD"
        },
        "base_tax": {
            "amount": 0.62,
            "currency": "AUD"
        },
        "cover": {
            "amount": 1.77,
            "currency": "AUD"
        },
        "cover_tax": {
            "amount": 0.18,
            "currency": "AUD"
        },
        "discount": {
            "amount": 0.0,
            "currency": "AUD"
        },
        "discount_tax": {
            "amount": 0.0,
            "currency": "AUD"
        },
        "fuel_surcharge": {
            "amount": 0.56,
            "currency": "AUD"
        },
        "fuel_surcharge_tax": {
            "amount": 0.06,
            "currency": "AUD"
        },
        "surcharge": {
            "amount": 0.0,
            "currency": "AUD"
        }
    },
    "tax_breakdown": {
        "gst": {
            "amount": 0.86,
            "currency": "AUD",
            "rate": 0.1
        }
    }
}