Nothing Found
    Nothing Found
Delivery Partner API
Version 1.2.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.

SecurityApiKeyAuth
Request
Request Body schema: application/json
required
event_type
required
string [ 1 .. 50 ] characters

The code indicating which type of event has occurred.

event_reason
required
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_date_time
required
string <date-time>

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

required
object (ArticleVO)

Article details.

required
object (AuditVO)

Audit details.

required
object (EventOriginatorVO)

Details of the System where the event originated.

object (DeliveryVO)

Delivery details.

object (FacilityVO)

Facility details

Responses
200

OK

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