Skip to content

Latest commit

 

History

History
186 lines (122 loc) · 7.79 KB

README.md

File metadata and controls

186 lines (122 loc) · 7.79 KB

ShippoAccounts

(shippo_accounts)

Overview

Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. Managed Shippo Accounts are headless accounts that represent your customers. They are opaque to your end customers, meaning customers do not need to create their own Shippo login or have a billing relationship with Shippo. They can be used by marketplaces, e-commerce platforms, and third-party logistics providers who want to offer, seamless, built-in shipping functionality to their customers. See our guide for more details.

Available Operations

  • list - List all Shippo Accounts
  • create - Create a Shippo Account
  • get - Retrieve a Shippo Account
  • update - Update a Shippo Account

list

Returns a list of Shippo Managed Accounts objects.

Example Usage

import shippo

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


res = s.shippo_accounts.list()

if res is not None:
    # handle response
    pass

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)

Response

components.ShippoAccountPaginatedList

Errors

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

create

Creates a new Shippo Managed Account.

Example Usage

import shippo
from shippo.models import components

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


res = s.shippo_accounts.create(request=components.ShippoAccountUpdateRequest(
    email='[email protected]',
    first_name='Shippo',
    last_name='Meister',
    company_name='Acme',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request components.ShippoAccountUpdateRequest ✔️ The request object to use for the request.

Response

components.ShippoAccount

Errors

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

get

Returns a Shippo Managed Account using an object ID.

Example Usage

import shippo

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


res = s.shippo_accounts.get(shippo_account_id='<value>')

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
shippo_account_id str ✔️ Object ID of the ShippoAccount

Response

components.ShippoAccount

Errors

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

update

Updates a Shippo Managed Account using an object ID.

Example Usage

import shippo
from shippo.models import components

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


res = s.shippo_accounts.update(shippo_account_id='<value>', shippo_account_update_request=components.ShippoAccountUpdateRequest(
    email='[email protected]',
    first_name='Shippo',
    last_name='Meister',
    company_name='Acme',
))

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
shippo_account_id str ✔️ Object ID of the ShippoAccount
shippo_account_update_request Optional[components.ShippoAccountUpdateRequest] ➖ N/A

Response

components.ShippoAccount

Errors

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