Skip to content

Latest commit

 

History

History
194 lines (126 loc) · 8.41 KB

README.md

File metadata and controls

194 lines (126 loc) · 8.41 KB

Addresses

(addresses)

Overview

Addresses are the locations a parcel is being shipped from and to. They represent company and residential places. Among other things, you can use address objects to create shipments, calculate shipping rates, and purchase shipping labels.

Available Operations

  • list - List all addresses
  • create - Create a new address
  • get - Retrieve an address
  • validate - Validate an address

list

Returns a list of all address objects that have been created in this account.

Example Usage

from shippo import Shippo


with Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version="2018-02-08",
) as s_client:

    res = s_client.addresses.list()

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
page Optional[int] ➖ The page number you want to select
results Optional[int] ➖ The number of results to return per page (max 100, default 5)
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

components.AddressPaginatedList

Errors

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

create

Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.

Example Usage

from shippo import Shippo


with Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version="2018-02-08",
) as s_client:

    res = s_client.addresses.create(request={
        "country": "US",
        "name": "Shwan Ippotle",
        "company": "Shippo",
        "street1": "215 Clayton St.",
        "street3": "",
        "street_no": "",
        "city": "San Francisco",
        "state": "CA",
        "zip": "94117",
        "phone": "+1 555 341 9393",
        "email": "[email protected]",
        "is_residential": True,
        "metadata": "Customer ID 123456",
        "validate_": True,
    })

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
request components.AddressCreateRequest ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

components.Address

Errors

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

get

Returns an existing address using an object ID.

Example Usage

from shippo import Shippo


with Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version="2018-02-08",
) as s_client:

    res = s_client.addresses.get(address_id="<id>")

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
address_id str ✔️ Object ID of the address
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

components.Address

Errors

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

validate

Validates an existing address using an object ID

Example Usage

from shippo import Shippo


with Shippo(
    api_key_header="<YOUR_API_KEY_HERE>",
    shippo_api_version="2018-02-08",
) as s_client:

    res = s_client.addresses.validate(address_id="<id>")

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
address_id str ✔️ Object ID of the address
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

components.Address

Errors

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