Nothing Found
    Nothing Found
Delivery Partner
Version 1.0.0
Select...

Sends the delivery event to Australia Post

Accepts Tracking Events which have resulted in a notification being sent by a delivery partner and which AP are to be informed of.

SecurityAUTH-KEY
Request
Request Body schema: application/json
required

event

required
object (Article)

Article details.

required
object (Audit)

Audit details.

object (Delivery)

Delivery details.

event_date_time
required
string <date-time>

The timestamp indication when the reason occurred in ISO 8601 Offset from UTC format.

required
object (EventOriginator)

Details of the System where the event originated.

event_reason
string [ 1 .. 50 ] characters

Text describing the event type reason.

event_reason_text
string [ 0 .. 80 ] characters

Text or comments describing the event reason as entered by user.

event_type
required
string [ 1 .. 50 ] characters

The code indicating which type of event has occurred.

object (Facility)

Facility details

Responses
200

OK

201

Created

401

Unauthorized

403

Forbidden

404

Not Found

post/api/v1/event
Request samples
application/json
{
  • "article": {
    },
  • "audit": {
    },
  • "delivery": {
    },
  • "event_date_time": "2019-07-08T09:04:45+10:00",
  • "event_originator": {
    },
  • "event_reason": "Transferred",
  • "event_reason_text": "BADLY DAMAGED",
  • "event_type": "string",
  • "facility": {
    }
}
Response samples
No sample