Skip to main content
Version: 2.0

Fetch a delivery

GET 
/standard/delivery

This endpoint is meant to be used for querying an existing delivery. [PREMIUM] To have access to this service you need a Premium Account.

Request​

Query Parameters

    id stringrequired

    Id of the delivery is been looked for

    Example: DEYDRHWNZGT97KF8

Header Parameters

    Authorization stringrequired

    Default value: Bearer <token>

Responses​

OK

Schema
    status string

    This is the status of the request to the server. Note: do not confuse with status of the delivery.

    delivery object
    dangerous_good boolean

    If a good is considered hazardous and needs special treatment then we advise to set this as true

    depth number

    The depth in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places

    dispatcher_status string

    pending - delivery hasn't been processed by the fleet. scheduled - delivery has already routing plan. picked - is already on the vehicle. moving - routing has started. delivered - dropoff has been executed. error - an error has been produced. cancelled - delivery has been aborted.

    dropoff_address string

    Receiver's address where the package/s will be dropped off.

    dropoff_comments stringnullable

    Comments while dropping off the package/s - i.e. please enter the red gateway and turn left

    dropoff_date_end string
    dropoff_date_start string
    dropoff_hour_end string
    dropoff_hour_start string
    dropoff_neighbour stringnullable

    If the agreement allows this service, this field will indicate what's the neighbour's name designated by the customer

    dropoff_neighbour_allowed boolean
    dropoff_postalcode string

    Receiver's postalcode where the package/s will be dropped off.

    dropoff_safeplace stringnullable

    If the agreement allows this service, this field will indicate what's the safeplace designated by the customer

    dropoff_safeplace_allowed boolean
    dropoff_w3w stringnullable

    Receiver's what3words encoded location where the package/s will be dropped off

    height number

    The height in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places

    id string

    SiG Internal ID

    lastmodifieddate string

    Last update received or produced in our system for a given delivery

    length number

    The length in cm of the parcel. Maximum integer length of 4 and maximum of 2 decimal places

    metadata string

    This field can be either an object or a string

    pickup_date_end string
    pickup_date_start string
    pickup_hour_end string
    pickup_hour_start string
    planned_arrival stringnullable

    After a delivery is planned this is the first estimate for arrival.

    proof_of_delivery stringnullable
    proof_of_delivery_signature stringnullable
    public_id string

    This ID is used as part of the Pubic Access for the customer. It is a unique identifier to avoid collision.

    public_link string

    This is the unique link identifier for a customer to access our Customer Portal. This portal allows the customer to modify the delivery.

    quantity number

    Quantity of parcels within this delivery

    sender string

    This is the ID reference from the sender. It is used normally as mapping between both platforms.

    sender_external_id string

    This is the ID reference from the sender. It is used normally as mapping between both platforms.

    sender_status string

    dispatched - it has been delivered to the fleet for routing plan. validated - it's pending to be handed over to the fleet. cancelled - it has been cancelled and will not be further updates. return - it's returned to the merchant.

    status_cancelled_at stringnullable
    status_delivered_at stringnullable
    weight number

    Field to host the weight of the delivery when is known. The standard units are Kg or lbs

Loading...