Skip to content

Latest commit

 

History

History
97 lines (77 loc) · 6 KB

README.md

File metadata and controls

97 lines (77 loc) · 6 KB
Raw

Pickups

(pickups())

Overview

A pickup is when you schedule a carrier to collect a package for delivery. Use Shippo’s pickups endpoint to schedule pickups with USPS and DHL Express for eligible shipments that you have already created.

Available Operations

create

Creates a pickup object. This request is for a carrier to come to a specified location to take a package for shipping.

Example Usage

package hello.world;

import com.shippo.sdk.Shippo;
import com.shippo.sdk.models.components.AddressCompleteCreateRequest;
import com.shippo.sdk.models.components.BuildingLocationType;
import com.shippo.sdk.models.components.BuildingType;
import com.shippo.sdk.models.components.Location;
import com.shippo.sdk.models.components.PickupBase;
import com.shippo.sdk.models.operations.CreatePickupResponse;
import java.lang.Exception;
import java.time.OffsetDateTime;
import java.util.List;

public class Application {

    public static void main(String[] args) throws Exception {

        Shippo sdk = Shippo.builder()
                .apiKeyHeader("<YOUR_API_KEY_HERE>")
                .shippoApiVersion("2018-02-08")
            .build();

        CreatePickupResponse res = sdk.pickups().create()
                .shippoApiVersion("2018-02-08")
                .pickupBase(PickupBase.builder()
                    .carrierAccount("adcfdddf8ec64b84ad22772bce3ea37a")
                    .location(Location.builder()
                        .address(AddressCompleteCreateRequest.builder()
                            .name("Shwan Ippotle")
                            .street1("215 Clayton St.")
                            .city("San Francisco")
                            .state("CA")
                            .zip("94117")
                            .country("US")
                            .company("Shippo")
                            .street3("")
                            .streetNo("")
                            .phone("+1 555 341 9393")
                            .email("[email protected]")
                            .isResidential(true)
                            .metadata("Customer ID 123456")
                            .validate(true)
                            .build())
                        .buildingLocationType(BuildingLocationType.FRONT_DOOR)
                        .buildingType(BuildingType.APARTMENT)
                        .instructions("Behind screen door")
                        .build())
                    .requestedEndTime(OffsetDateTime.parse("2023-06-18T07:14:55.338Z"))
                    .requestedStartTime(OffsetDateTime.parse("2023-12-01T17:06:07.804Z"))
                    .transactions(List.of(
                        "adcfdddf8ec64b84ad22772bce3ea37a"))
                    .build())
                .call();

        if (res.pickup().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description Example
shippoApiVersion Optional ➖ String used to pick a non-default API version to use 2018-02-08
pickupBase PickupBase ✔️ Shippo’s pickups endpoint allows you to schedule pickups with USPS and DHL Express for eligible shipments that you have already created.

Response

CreatePickupResponse

Errors

Error Object Status Code Content Type
models/errors/SDKError 4xx-5xx */*