Syntax

listDeliveries( search=[] )

Gives back a list of your deliveries.

Access rights

readonly or writable required.

Arguments

search – optional. An array with search criteria

  • purchase_id - an order id
  • from - date
  • to - date
  • type- comma seperated list of:
    • request - the order has not been processed. The items are to be sent.
    • in_progress - one of your delivery handling agents is currently dealing with the delivery.
    • delivery - all items of the delivery have been sent
    • partial_delivery - some items of the delivey have been sent
    • return - the package has been returned - maybe the shipping address was wrong
    • cancel - the delivery has been canceled - maybe because of a refund of the purchase
  • same_address_as - delivery_id - lists all delivery shipped to the same address as the given delivery_id.
  • is_processed - bool
  • is_test_order- bool
    • list only real orders: search[is_test_order]=N
    • list only test orders: search[is_test_order]=Y

Return data

List of delivies.

[delivery] => Array
(
    [0] => Array
        (
            [delivery_address] => Array
                (
                    [title] => 
                    [salutation] => M
                    [company] => 
                    [first_name] => Helen
                    [last_name] => Myer
                    [street] => Some Street
                    [street2] => 
                    [street_number] => 4321
                    [city] => Some City
                    [state] => NY
                    [zipcode] => 12345
                    [country] => US
                    [email] => someuser@email.com
                    [phone_no] => 
                    [tax_id] => 
                    [country_name] => USA
                )

            [delivery_type] => shipping
            [product_type_name] => Dietary supplement - health
            [tracking] => Array
                (
                    [0] => Array
                        (
                            [delivery_id] => 6442755
                            [parcel_service_type] => ups
                            [service_label] => UPS
                            [tracking_id] => 12748999983421543437130661
                            [tracking_url] => http://wwwapps.ups.com/WebTracking/processInputRequest?TypeOfInquiryNumber=T&InquiryNumber1=12748999983421543437130661
                            [quantity] => 1
                            [ipn_config_id] => 
                        )

                )

            [quantity_total] => 1
            [id] => 6446755
            [purchase_id] => AC6FUE4N
            [purchase_created_at] => 2021-07-27 02:32:13
            [purchase_item_id] => 27900026
            [buyer_address_id] => 19113624
            [type] => delivery
            [processed_at] => 
            [processed_by] => 
            [product_id] => 367544
            [product_name] => Healing Potion - 3 bottle
            [product_type_id] => 49
            [variant_label] => 
            [variant_name] => 
            [variant_key] => 
            [variant_id] => 0
            [quantity_delivered] => 1
            [is_shippment_by_reseller_id] => 
            [is_test_order] = N 
        )
)

See also: