Skip to content

Latest commit

 

History

History
91 lines (58 loc) · 4.66 KB

README.md

File metadata and controls

91 lines (58 loc) · 4.66 KB
Raw

CarrierParcelTemplates

(carrier_parcel_templates)

Overview

A carrier parcel template represents a package used for shipping that has preset dimensions defined by a carrier. Some examples of a carrier parcel template include USPS Flat Rate Box and Fedex Small Pak. When using a carrier parcel template, the rates returned may be limited to the carrier that provides the box. You can create user parcel templates using a carrier parcel template. Shippo takes the dimensions of the carrier parcel template but you must configure the weight.

Available Operations

  • list - List all carrier parcel templates
  • get - Retrieve a carrier parcel templates

list

List all carrier parcel template objects.
Use the following query string params to filter the results as needed.

  • include=all (the default). Includes templates from all carriers
  • include=user. Includes templates only from carriers which the user has added (whether or not they're currently enabled)
  • include=enabled. includes templates only for carriers which the user has added and enabled
  • carrier=*token*. filter by specific carrier, e.g. fedex, usps

Example Usage

import shippo
from shippo.models import operations

s = shippo.Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version='2018-02-08',
)

res = s.carrier_parcel_templates.list(include=operations.Include.ENABLED, carrier='fedex')

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description Example
include Optional[operations.Include] ➖ filter by user or enabled
carrier Optional[str] ➖ filter by specific carrier fedex

Response

List[components.CarrierParcelTemplate]

Errors

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

get

Fetches the parcel template information for a specific carrier parcel template, identified by the token.

Example Usage

import shippo

s = shippo.Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version='2018-02-08',
)

res = s.carrier_parcel_templates.get(carrier_parcel_template_token='<value>')

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
carrier_parcel_template_token str ✔️ The unique string representation of the carrier parcel template

Response

components.CarrierParcelTemplate

Errors

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