Skip to content

Latest commit

 

History

History
297 lines (212 loc) · 24.3 KB

README.md

File metadata and controls

297 lines (212 loc) · 24.3 KB
Raw

UserParcelTemplates

(userParcelTemplates())

Overview

A user parcel template represents a package used for shipping that has preset dimensions and attributes defined by you. They are useful for capturing attributes of parcel-types you frequently use for shipping, allowing them to be defined once and then used for many shipments. These parcel templates can also be used for live rates.

User parcel templates can also be created using a carrier parcel template, where the dimensions will be copied from the carrier presets, but the weight can be configured by you.

Available Operations

  • list - List all user parcel templates
  • create - Create a new user parcel template
  • delete - Delete a user parcel template
  • get - Retrieves a user parcel template
  • update - Update an existing user parcel template

list

Returns a list all of all user parcel template objects.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.ListUserParcelTemplatesResponse;
import java.lang.Exception;

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();

        ListUserParcelTemplatesResponse res = sdk.userParcelTemplates().list()
                .shippoApiVersion("2018-02-08")
                .call();

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

Parameters

Parameter Type Required Description Example
shippoApiVersion Optional<String> ➖ Optional string used to pick a non-default API version to use. See our API version guide. 2018-02-08

Response

ListUserParcelTemplatesResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

create

Creates a new user parcel template.
You can choose to create a parcel template using a preset carrier template as a starting point, or you can create an entirely custom one. To use a preset carrier template, pass in a unique template token from this list plus the weight fields (weight and weight_unit). Otherwise, omit the template field and pass the other fields, for the weight, length, height, and depth, as well as their units."

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.UserParcelTemplateCreateRequest;
import com.goshippo.shippo_sdk.models.components.UserParcelTemplateWithCarrierTemplateCreateRequest;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.CreateUserParcelTemplateResponse;
import java.lang.Exception;

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();

        CreateUserParcelTemplateResponse res = sdk.userParcelTemplates().create()
                .shippoApiVersion("2018-02-08")
                .userParcelTemplateCreateRequest(UserParcelTemplateCreateRequest.of(UserParcelTemplateWithCarrierTemplateCreateRequest.builder()
                    .weight("12")
                    .weightUnit(WeightUnitEnum.LB)
                    .build()))
                .call();

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

Parameters

Parameter Type Required Description Example
shippoApiVersion Optional<String> ➖ Optional string used to pick a non-default API version to use. See our API version guide. 2018-02-08
userParcelTemplateCreateRequest UserParcelTemplateCreateRequest ✔️ N/A

Response

CreateUserParcelTemplateResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

delete

Deletes a user parcel template using an object ID.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.DeleteUserParcelTemplateResponse;
import java.lang.Exception;

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();

        DeleteUserParcelTemplateResponse res = sdk.userParcelTemplates().delete()
                .userParcelTemplateObjectId("<id>")
                .shippoApiVersion("2018-02-08")
                .call();

        // handle response
    }
}

Parameters

Parameter Type Required Description Example
userParcelTemplateObjectId String ✔️ Object ID of the user parcel template
shippoApiVersion Optional<String> ➖ Optional string used to pick a non-default API version to use. See our API version guide. 2018-02-08

Response

DeleteUserParcelTemplateResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

get

Returns the parcel template information for a specific user parcel template, identified by the object ID.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.operations.GetUserParcelTemplateResponse;
import java.lang.Exception;

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();

        GetUserParcelTemplateResponse res = sdk.userParcelTemplates().get()
                .userParcelTemplateObjectId("<id>")
                .shippoApiVersion("2018-02-08")
                .call();

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

Parameters

Parameter Type Required Description Example
userParcelTemplateObjectId String ✔️ Object ID of the user parcel template
shippoApiVersion Optional<String> ➖ Optional string used to pick a non-default API version to use. See our API version guide. 2018-02-08

Response

GetUserParcelTemplateResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*

update

Updates an existing user parcel template.

Example Usage

package hello.world;

import com.goshippo.shippo_sdk.Shippo;
import com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;
import com.goshippo.shippo_sdk.models.components.UserParcelTemplateUpdateRequest;
import com.goshippo.shippo_sdk.models.components.WeightUnitEnum;
import com.goshippo.shippo_sdk.models.operations.UpdateUserParcelTemplateResponse;
import java.lang.Exception;

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();

        UpdateUserParcelTemplateResponse res = sdk.userParcelTemplates().update()
                .userParcelTemplateObjectId("<id>")
                .shippoApiVersion("2018-02-08")
                .userParcelTemplateUpdateRequest(UserParcelTemplateUpdateRequest.builder()
                    .distanceUnit(DistanceUnitEnum.IN)
                    .height("6")
                    .length("10")
                    .name("My Custom Template")
                    .width("8")
                    .weight("12")
                    .weightUnit(WeightUnitEnum.LB)
                    .build())
                .call();

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

Parameters

Parameter Type Required Description Example
userParcelTemplateObjectId String ✔️ Object ID of the user parcel template
shippoApiVersion Optional<String> ➖ Optional string used to pick a non-default API version to use. See our API version guide. 2018-02-08
userParcelTemplateUpdateRequest Optional<UserParcelTemplateUpdateRequest> ➖ N/A

Response

UpdateUserParcelTemplateResponse

Errors

Error Type Status Code Content Type
models/errors/SDKError 4XX, 5XX */*