Sendle · Example Payload

Sendle Create Order Example

ShippingLogisticsLast MileParcelsE-commerceCarbon NeutralSmall BusinessAustraliaUnited StatesCanada

Sendle Create Order Example is an example object payload from Sendle, with 2 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

requestresponse

Example Payload

Raw ↑
{
  "request": {
    "method": "POST",
    "url": "https://api.sendle.com/api/orders",
    "headers": {
      "Authorization": "Basic <base64(SendleID:APIKey)>",
      "Content-Type": "application/json",
      "Idempotency-Key": "1f04ab38-9d3f-4f5c-8b6e-7d6db1d4a611"
    },
    "body": {
      "sender": {
        "contact": { "name": "Lex Luthor", "phone": "0491 570 313", "email": "lluthor@example.com", "company": "LexCorp" },
        "address": { "address_line1": "123 Gotham Ln", "suburb": "Sydney", "state_name": "NSW", "postcode": "2000", "country": "AU" },
        "instructions": "Knock loudly"
      },
      "receiver": {
        "contact": { "name": "Clark Kent", "email": "clarkissuper@dailyplanet.xyz", "company": "Daily Planet" },
        "address": { "address_line1": "80 Wentworth Park Road", "suburb": "Glebe", "state_name": "NSW", "postcode": "2037", "country": "AU" },
        "instructions": "Give directly to Clark"
      },
      "description": "Kryptonite",
      "weight": { "value": "1.0", "units": "kg" },
      "dimensions": { "length": "30.0", "width": "20.0", "height": "17.0", "units": "cm" },
      "customer_reference": "SupBdayPressie",
      "metadata": { "your_data": "XYZ123" },
      "hide_pickup_address": true,
      "packaging_type": "box"
    }
  },
  "response": {
    "status": 201,
    "body": {
      "order_id": "411a3b6e-9d3f-4f5c-8b6e-7d6db1d4a611",
      "state": "Pickup",
      "order_url": "https://api.sendle.com/api/orders/411a3b6e-9d3f-4f5c-8b6e-7d6db1d4a611",
      "sendle_reference": "S3NDLE",
      "tracking_url": "https://track.sendle.com/tracking?ref=S3NDLE",
      "labels": [
        { "format": "pdf", "size": "a4", "url": "https://api.sendle.com/api/orders/411a3b6e-9d3f-4f5c-8b6e-7d6db1d4a611/labels?format=pdf&size=a4" }
      ],
      "scheduling": { "is_cancellable": true, "pickup_date": "2026-05-26", "delivered_on": null },
      "price": {
        "gross": { "amount": 8.47, "currency": "AUD" },
        "net": { "amount": 7.70, "currency": "AUD" },
        "tax": { "amount": 0.77, "currency": "AUD" }
      },
      "product": { "code": "STANDARD-PICKUP", "name": "Standard Pickup", "first_mile_option": "pickup", "service": "standard" }
    }
  }
}