POST Webhooks

Request Information

URI Parameters

None.

Body Parameters

GetPackage
NameDescriptionTypeAdditional information
id

integer

None.

item

Item

None.

pickup_date

date

None.

is_urgent

boolean

None.

status

string

None.

status_code

string

None.

reason_name

Object

None.

base_price

decimal number

None.

courier

Object

None.

vat

decimal number

None.

stop_points

Collection of StopPoint

None.

is_shared_location

boolean

None.

delivery_id

integer

None.

created_at

date

None.

waiting_time_price

integer

None.

distance

integer

None.

is_now

boolean

None.

real_start_date

Object

None.

real_completed_date

Object

None.

pickup_time_range

string

None.

dropoff_time_range

string

None.

is_same_day

boolean

None.

notes

Object

None.

confirmation

string

None.

provider_custom_data

Object

None.

is_food

boolean

None.

business_company

string

None.

route_id

integer

None.

confirmation_link

Object

None.

confirmation_recipient_name

Object

None.

requested_deadline

Object

None.

delivery_deadline

Object

None.

Request Formats

application/json, text/json

Sample:
{
  "id": 1,
  "item": {
    "delivery_type": "sample string 1",
    "package_id": "sample string 2"
  },
  "pickup_date": "2025-04-04T03:33:23.1104835+03:00",
  "is_urgent": true,
  "status": "sample string 4",
  "status_code": "sample string 5",
  "reason_name": {},
  "base_price": 7.1,
  "courier": {},
  "vat": 9.1,
  "stop_points": [
    {
      "completed_date": {},
      "contact": {
        "full_name": "sample string 1",
        "phone_number": "sample string 2"
      },
      "instruction": {},
      "location": {
        "address": "sample string 1",
        "longitude": 2.1,
        "latitude": 3.1
      },
      "required_secure": true,
      "started_date": {},
      "status": "sample string 5",
      "type": "sample string 6",
      "waiting_date": {},
      "order": 8,
      "photo_proofs": [
        {},
        {}
      ]
    },
    {
      "completed_date": {},
      "contact": {
        "full_name": "sample string 1",
        "phone_number": "sample string 2"
      },
      "instruction": {},
      "location": {
        "address": "sample string 1",
        "longitude": 2.1,
        "latitude": 3.1
      },
      "required_secure": true,
      "started_date": {},
      "status": "sample string 5",
      "type": "sample string 6",
      "waiting_date": {},
      "order": 8,
      "photo_proofs": [
        {},
        {}
      ]
    }
  ],
  "is_shared_location": true,
  "delivery_id": 11,
  "created_at": "2025-04-04T03:33:23.1144906+03:00",
  "waiting_time_price": 13,
  "distance": 14,
  "is_now": true,
  "real_start_date": {},
  "real_completed_date": {},
  "pickup_time_range": "sample string 18",
  "dropoff_time_range": "sample string 19",
  "is_same_day": true,
  "notes": {},
  "confirmation": "sample string 22",
  "provider_custom_data": {},
  "is_food": true,
  "business_company": "sample string 25",
  "route_id": 26,
  "confirmation_link": {},
  "confirmation_recipient_name": {},
  "requested_deadline": {},
  "delivery_deadline": {}
}

application/xml, text/xml

Sample:
<GetPackage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TMSWebAPI.Models.GetPackage">
  <BasePrice>7.1</BasePrice>
  <BusinessCompany>sample string 25</BusinessCompany>
  <Confirmation>sample string 22</Confirmation>
  <ConfirmationLink />
  <ConfirmationRecipientName />
  <Courier />
  <CreatedAt xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-04T00:33:23.1144906Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>180</d2p1:OffsetMinutes>
  </CreatedAt>
  <DeliveryDeadline />
  <DeliveryId>11</DeliveryId>
  <Distance>14</Distance>
  <DropoffTimeRange>sample string 19</DropoffTimeRange>
  <Id>1</Id>
  <IsFood>true</IsFood>
  <IsNow>true</IsNow>
  <IsSameDay>true</IsSameDay>
  <IsSharedLocation>true</IsSharedLocation>
  <IsUrgent>true</IsUrgent>
  <Item>
    <DeliveryType>sample string 1</DeliveryType>
    <PackageId>sample string 2</PackageId>
  </Item>
  <Notes />
  <PickupDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>2025-04-04T00:33:23.1104835Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>180</d2p1:OffsetMinutes>
  </PickupDate>
  <PickupTimeRange>sample string 18</PickupTimeRange>
  <ProviderCustomData />
  <RealCompletedDate />
  <RealStartDate />
  <ReasonName />
  <RequestedDeadline />
  <RouteId>26</RouteId>
  <Status>sample string 4</Status>
  <StatusCode>sample string 5</StatusCode>
  <StopPoints>
    <StopPoint>
      <CompletedDate />
      <Contact>
        <FullName>sample string 1</FullName>
        <PhoneNumber>sample string 2</PhoneNumber>
      </Contact>
      <Instruction />
      <Location>
        <Address>sample string 1</Address>
        <Latitude>3.1</Latitude>
        <Longitude>2.1</Longitude>
      </Location>
      <Order>8</Order>
      <PhotoProofs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </PhotoProofs>
      <RequiredSecure>true</RequiredSecure>
      <StartedDate />
      <Status>sample string 5</Status>
      <Type>sample string 6</Type>
      <WaitingDate />
    </StopPoint>
    <StopPoint>
      <CompletedDate />
      <Contact>
        <FullName>sample string 1</FullName>
        <PhoneNumber>sample string 2</PhoneNumber>
      </Contact>
      <Instruction />
      <Location>
        <Address>sample string 1</Address>
        <Latitude>3.1</Latitude>
        <Longitude>2.1</Longitude>
      </Location>
      <Order>8</Order>
      <PhotoProofs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:anyType />
        <d4p1:anyType />
      </PhotoProofs>
      <RequiredSecure>true</RequiredSecure>
      <StartedDate />
      <Status>sample string 5</Status>
      <Type>sample string 6</Type>
      <WaitingDate />
    </StopPoint>
  </StopPoints>
  <Vat>9.1</Vat>
  <WaitingTimePrice>13</WaitingTimePrice>
</GetPackage>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.

Content

HttpContent

None.

StatusCode

HttpStatusCode

None.

ReasonPhrase

string

None.

Headers

Collection of Object

None.

RequestMessage

HttpRequestMessage

None.

IsSuccessStatusCode

boolean

None.