{ "openapi": "3.1.0", "info": { "title": "Shippo external API.", "version": "2018-02-08", "x-logo": { "url": "https://docs.goshippo.com/images/shippo-logo.svg" }, "contact": { "name": "Shippo Developer Platform", "url": "https://goshippo.com/contact/" }, "description": "Use this API to integrate with the Shippo service" }, "security": [ { "APIKeyHeader": [] } ], "servers": [ { "url": "https://api.goshippo.com" } ], "tags": [ { "name": "Overview", "description": "

\n First-time users and those looking for specific integration tutorials,\n see our full API documentation and guides.
\n Download the API Specification yaml file\n

\n\n

API Resources

\nAll API URLs listed in this documentation are relative to https://api.goshippo.com/.\n\nFor example, the `/addresses/` resource is reachable at `https://api.goshippo.com/addresses/`.\n\n\n

Authentication

\nThe API requires Shippo's token HTTP Authentication with your Shippo token (live or test). \n\nIn order to authenticate properly, please put `Authorization: ShippoToken ` in your header. You can find your token on the \nShippo API settings page.\n\n\n\nFor more information about authentication and test mode, \nplease visit our Authentication guide.\n\nThe API is available via Secure Socket Layer (SSL) only. All requests to the Shippo API must use TLS version 1.2 or higher.\n\n

Request & Response Data

\nRequest data is passed to the API by POSTing JSON objects with the appropriate key/value-pairs to the respective \nresource. The documentation for each API resource contains more details on the values accepted by a given resource.\n\nResponse data also formatted as JSON object. You can specify how many results per page are to be returned. For instance, \n`/rates/?results=25` will return up to 25 results.\n\n

REST & Disposable Objects

\nThe Shippo API is built around REST principles. \nUse POST requests to create objects, GET requests to retrieve objects, and PUT requests to update objects.\n\nOnly the Carrier Accounts object can be updated via PUT requests. All other objects such as Addresses, Parcels, \nShipments, Rates, Transactions, Refunds, Customs Items, and Customs Declarations are disposable. This means that \nonce you have created an object, you cannot change it. Instead, create a new one with the desired values.\n\n

API Version

\n\nThis reference guide supports the Shippo API version: `2018-02-08` . \n\nTo see reference guides for older API versions, see our legacy reference guide. \nFor more information about Shippo API versions, see our API versions guide." }, { "name": "Addresses", "description": "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." }, { "name": "Parcels", "description": "A parcel is an item you are shipping. The parcel object includes details about its physical make-up of the parcel. It includes dimensions and weight that Shippo uses to calculate rates." }, { "name": "Shipments", "description": "A shipment is the act of transporting goods. A shipment object contains **to** and **from** addresses, and the parcel details that you are shipping. You can use the shipment object to retrieve shipping rates and purchase a shipping label." }, { "name": "Rates", "description": "A rate is the cost to ship a parcel from a carrier. The rate object details the service level including the cost and transit time. " }, { "name": "Transactions", "x-displayName": "Transactions (shipping labels)", "description": "A transaction is the purchase of a shipping label from a shipping provider for a specific service. You can print purchased labels and used them to ship a parcel with a carrier, such as USPS or FedEx." }, { "name": "Customs Items", "description": "Customs declarations are relevant information, including one or multiple customs items, you need to provide for customs clearance for your international shipments." }, { "name": "Customs Declarations", "description": "Customs declarations are relevant information, including one or multiple customs items, you need to provide for \ncustoms clearance for your international shipments." }, { "name": "Refunds", "description": "Refunds are reimbursements for successfully created but unused shipping labels or other charges." }, { "name": "Manifests", "description": "A manifest is a single-page document with a barcode that carriers can scan to accept all packages into transit without the need to scan each item individually.\nThey are close-outs of shipping labels of a certain day. Some carriers require manifests to process the shipments." }, { "name": "Carrier Accounts", "description": "Carriers are the companies who deliver your package. Shippo uses Carrier account objects as credentials to retrieve shipping rates and purchase labels from shipping Carriers." }, { "name": "Webhooks", "description": "Webhooks are a way for Shippo to notify your application when a specific event occurs. For example, when a label is purchased or when a shipment tracking status has changed. You can use webhooks to trigger actions in your application, such as sending an email or updating a database." }, { "name": "Tracking Status", "description": "


\nIf you purchased your shipping label through Shippo, you can also get all the tracking details of your Shipment \nfrom the Transaction object.\n

\nA tracking status of a package is an indication of current location of a package in the supply chain. For example, sorting, warehousing, or out for delivery. Use the tracking status object to track the location of your shipments.\n\nWhen using your Test token for tracking, you need to use Shippo's \npredefined tokens for testing different tracking statuses. You can find more information in our \nTracking tutorial on how to do this, and what the \npayloads look like. " }, { "name": "Batches", "description": "A batch is a technique for creating multiple labels at once. Use the batch object to create and purchase many shipments in two API calls. After creating the batch, retrieve the batch to verify that all shipments are valid. You can add and remove shipments after you have created the batch. When all shipments are valid you can purchase the batch and retrieve all the shipping labels." }, { "name": "Orders", "x-displayName": "Orders (beta)", "description": "An order is a request from a customer to purchase goods from a merchant.\nUse the orders object to load orders from your system to the Shippo dashboard.\nYou can use the orders object to create, retrieve, list, and manage orders programmatically.\nYou can also retrieve shipping rates, purchase labels, and track shipments for each order." }, { "name": "Pickups", "description": "A pickup is when you schedule a carrier to collect a package for delivery.\nUse Shippo’s pickups endpoint to schedule pickups with USPS and DHL Express for eligible shipments that you have already created." }, { "name": "Service Groups", "description": "A service group is a set of service levels grouped together. \nRates at checkout uses services groups to present available shipping options to customers in their shopping basket." }, { "name": "Carrier Parcel Templates", "description": "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." }, { "name": "User Parcel Templates", "description": "A user parcel template represents a package used for shipping that has preset dimensions and attributes defined \nby you. They are useful for capturing attributes of parcel-types you frequently use for shipping, allowing \nthem to be defined once and then used for many shipments. These parcel templates can also be used for live rates.\n\nUser parcel templates can also be created using a carrier parcel template, where the dimensions will be copied from \nthe carrier presets, but the weight can be configured by you." }, { "name": "Rates at Checkout", "description": "Rates at checkout is a tool for merchants to display up-to-date shipping estimates based on what's in their customers cart and where they’re shipping to.\nMerchants set up curated shipping options for customers in the checkout flow based on data in the shopping cart. The request must include the **to** address and item information. Optional fields are the **from** address and package information. If the optional fields are not included, the service will use the default address and/or package configured for rates at checkout. The response is a list of shipping options based on the Service Group configuration.\n(see Service Group configuration for details).\n\n\n\n# Default Parcel Template\nAssign one of your user parcel templates to be the default used when generating Live Rates. This template will be used by default when generating Live Rates, unless you explicitly provide a parcel in the Live Rates request." }, { "name": "Carriers", "description": "|Token | Carrier name|\n|:---|:---|\n| airterra | Airterra |\n| apc_postal | APC Postal|\n| apg | APG|\n| aramex | Aramex|\n| asendia_us | Asendia US|\n| australia_post | Australia Post (also used for Startrack)|\n| axlehire | Jitsu|\n| better_trucks | BetterTrucks|\n| borderguru | BorderGuru|\n| boxberry | Boxberry|\n| bring | Bring (also used for Posten Norge)|\n| canada_post | Canada Post|\n| cdl | CDL|\n| chronopost | Chronopost|\n| collect_plus | CollectPlus|\n| correios_br | CorreiosBR|\n| correos_espana | Correos España |\n| colissimo | Colissimo|\n| deutsche_post | Deutsche Post|\n| dhl_benelux | DHL Benelux|\n| dhl_ecommerce | DHL eCommerce|\n| dhl_express | DHL Express|\n| dhl_germany_c2c | DHL Germany C2C|\n| dhl_germany | DHL Germany|\n| dpd_de | DPD GERMANY|\n| dpd_uk | DPD UK|\n| estafeta | Estafeta|\n| fastway_australia | Aramex|\n| fedex | FedEx|\n| globegistics | Globegistics (now Asendia)|\n| gls_us | GLS US|\n| gophr | Gophr|\n| gso | GSO|\n| hermes_germany_b2c | Hermes Germany B2C|\n| hermes_uk | Evri UK |\n| hongkong_post | Hongkong Post|\n| lasership | LaserShip|\n| lso | LSO|\n| mondial_relay | Mondial Relay|\n| new_zealand_post | New Zealand Post (also used for Pace and CourierPost)|\n| nippon_express | Nippon Express|\n| ontrac | OnTrac|\n| parcelforce | Parcelforce|\n| passport | Passport|\n| pcf | PCF|\n| poste_italiane | Poste Italiane |\n| posti | Posti|\n| purolator | Purolator|\n| royal_mail | Royal Mail|\n| royal_mail_sf | Royal Mail Storefeeder|\n| rr_donnelley | ePost Global|\n| russian_post | Russian Post|\n| skypostal | SkyPostal|\n| stuart | Stuart|\n| swyft | Swyft|\n| uds | UDS (United Delivery Service)|\n| ups | UPS|\n| usps | USPS|\n| veho | Veho |\n" }, { "name": "Service Levels", "description": "Service levels represent the shipping service type for each carrier. Use the tokens below when creating shipments.\n\n## USPS Service Levels\n|Token | Service name|\n|:---|:---|\n| usps_priority | Priority Mail|\n| usps_priority_express | Priority Mail Express|\n| usps_media_mail | Media Mail (grandfathered customers only)|\n| usps_priority_mail_international | Priority Mail International|\n| usps_priority_mail_express_international | Priority Mail Express International|\n| usps_first_class_package_international_service | First Class Package International|\n| usps_ground_advantage | Ground Advantage |\n\n## FedEx Service Levels\n|Token | Service name|\n|:---|:---|\n| fedex_ground | FedEx Ground®|\n| fedex_home_delivery | FedEx Home Delivery®|\n| fedex_ground_economy | FedEx Ground® Economy|\n| fedex_2_day | FedEx 2Day®|\n| fedex_2_day_am | FedEx 2Day® A.M.|\n| fedex_express_saver | FedEx Express Saver®|\n| fedex_standard_overnight | FedEx Standard Overnight®|\n| fedex_priority_overnight | FedEx Priority Overnight®|\n| fedex_first_overnight | FedEx First Overnight®|\n| fedex_international_economy | FedEx International Economy®|\n| fedex_international_priority | FedEx International Priority®|\n| fedex_international_first | FedEx International First®|\n| fedex_international_connect_plus | FedEx International Connect Plus|\n\n## UPS Service Levels\n|Token | Service name|\n|:---|:---|\n| ups_standard | UPS Standard|\n| ups_ground | UPS Ground|\n| ups_saver | UPS Saver|\n| ups_3_day_select | UPS 3 Day Select|\n| ups_second_day_air | UPS 2nd Day Air|\n| ups_second_day_air_am | UPS 2nd Day Air A.M.|\n| ups_next_day_air | UPS Next Day Air|\n| ups_next_day_air_saver | UPS Next Day Air Saver|\n| ups_next_day_air_early_am | UPS Next Day Air Early A.M.|\n| ups_express | UPS Express|\n| ups_express_plus | UPS Express Plus|\n| ups_expedited | UPS Expedited|\n\n## Other Supported Carriers\nAdditional service levels are available for: Airterra, APC Postal, APG, Asendia, Australia Post, \nBetter Trucks, Canada Post, CDL, Chronopost, Colissimo, Correos España, DHL Express, DHL eCommerce, \nDHL Germany, DPD DE, DPD UK, Deutsche Post, Aramex Australia, Globegistics, GLS US, Jitsu, LaserShip, \nLSO, Mondial Relay, OnTrac, Parcelforce, Poste Italiane, ePost Global, Purolator, Royal Mail, \nRoyal Mail Storefeeder, Swyft, UDS, Veho, and Evri UK.\n\nSee the Schemas section for complete service level lists for each carrier.\n" }, { "name": "Parcel Templates", "description": "A predefined package used by one or multiple carriers. When a template is given, the parcel dimensions \ndo not have to be sent - the dimensions below will instead be used. The parcel weight is not affected \nby the use of a template.\n\n## FedEx Parcel Templates\n|Token | Name | Dimensions|\n|:---|:---|:---|\n| FedEx_Box_10kg | FedEx® 10kg Box | 15.81 x 12.94 x 10.19 in|\n| FedEx_Box_25kg | FedEx® 25kg Box | 54.80 x 42.10 x 33.50 in|\n| FedEx_Box_Extra_Large_1 | FedEx® Extra Large Box (X1) | 11.88 x 11.00 x 10.75 in|\n| FedEx_Box_Extra_Large_2 | FedEx® Extra Large Box (X2) | 15.75 x 14.13 x 6.00 in|\n| FedEx_Box_Large_1 | FedEx® Large Box (L1) | 17.50 x 12.38 x 3.00 in|\n| FedEx_Box_Large_2 | FedEx® Large Box (L2) | 11.25 x 8.75 x 7.75 in|\n| FedEx_Box_Medium_1 | FedEx® Medium Box (M1) | 13.25 x 11.50 x 2.38 in|\n| FedEx_Box_Medium_2 | FedEx® Medium Box (M2) | 11.25 x 8.75 x 4.38 in|\n| FedEx_Box_Small_1 | FedEx® Small Box (S1) | 12.38 x 10.88 x 1.50 in|\n| FedEx_Box_Small_2 | FedEx® Small Box (S2) | 11.25 x 8.75 x 4.38 in|\n| FedEx_Envelope | FedEx® Envelope | 12.50 x 9.50 x 0.80 in|\n| FedEx_Padded_Pak | FedEx® Padded Pak | 11.75 x 14.75 x 2.00 in|\n| FedEx_Pak_1 | FedEx® Large Pak | 15.50 x 12.00 x 0.80 in|\n| FedEx_Pak_2 | FedEx® Small Pak | 12.75 x 10.25 x 0.80 in|\n| FedEx_Tube | FedEx® Tube | 38.00 x 6.00 x 6.00 in|\n| FedEx_XL_Pak | FedEx® Extra Large Pak | 17.50 x 20.75 x 2.00 in|\n\n## UPS Parcel Templates\n|Token | Name | Dimensions|\n|:---|:---|:---|\n| UPS_Box_10kg | Box 10kg | 410.00 x 335.00 x 265.00 mm|\n| UPS_Box_25kg | Box 25kg | 484.00 x 433.00 x 350.00 mm|\n| UPS_Express_Box | Express Box | 460.00 x 315.00 x 95.00 mm|\n| UPS_Express_Box_Large | Express Box Large | 18.00 x 13.00 x 3.00 in|\n| UPS_Express_Box_Medium | Express Box Medium | 15.00 x 11.00 x 3.00 in|\n| UPS_Express_Box_Small | Express Box Small | 13.00 x 11.00 x 2.00 in|\n| UPS_Express_Envelope | Express Envelope | 12.50 x 9.50 x 2.00 in|\n| UPS_Express_Hard_Pak | Express Hard Pak | 14.75 x 11.50 x 2.00 in|\n| UPS_Express_Legal_Envelope | Express Legal Envelope | 15.00 x 9.50 x 2.00 in|\n| UPS_Express_Pak | Express Pak | 16.00 x 12.75 x 2.00 in|\n| UPS_Express_Tube | Express Tube | 970.00 x 190.00 x 165.00 mm|\n| UPS_Laboratory_Pak | Laboratory Pak | 17.25 x 12.75 x 2.00 in|\n| UPS_Pad_Pak | Pad Pak | 14.75 x 11.00 x 2.00 in|\n\n## USPS Parcel Templates\n|Token | Name | Dimensions|\n|:---|:---|:---|\n| USPS_FlatRateCardboardEnvelope | Flat Rate Cardboard Envelope | 12.50 x 9.50 x 0.75 in|\n| USPS_FlatRateEnvelope | Flat Rate Envelope | 12.50 x 9.50 x 0.75 in|\n| USPS_FlatRateGiftCardEnvelope | Flat Rate Gift Card Envelope | 10.00 x 7.00 x 0.75 in|\n| USPS_FlatRateLegalEnvelope | Flat Rate Legal Envelope | 15.00 x 9.50 x 0.75 in|\n| USPS_FlatRatePaddedEnvelope | Flat Rate Padded Envelope | 12.50 x 9.50 x 1.00 in|\n| USPS_FlatRateWindowEnvelope | Flat Rate Window Envelope | 10.00 x 5.00 x 0.75 in|\n| USPS_LargeFlatRateBoardGameBox | Large Flat Rate Board Game Box | 24.06 x 11.88 x 3.13 in|\n| USPS_LargeFlatRateBox | Large Flat Rate Box | 12.25 x 12.25 x 6.00 in|\n| USPS_APOFlatRateBox | APO/FPO/DPO Large Flat Rate Box | 12.25 x 12.25 x 6.00 in|\n| USPS_MediumFlatRateBox1 | Medium Flat Rate Box 1 | 11.25 x 8.75 x 6.00 in|\n| USPS_MediumFlatRateBox2 | Medium Flat Rate Box 2 | 14.00 x 12.00 x 3.50 in|\n| USPS_RegionalRateBoxA1 | Regional Rate Box A1 | 10.13 x 7.13 x 5.00 in|\n| USPS_RegionalRateBoxA2 | Regional Rate Box A2 | 13.06 x 11.06 x 2.50 in|\n| USPS_RegionalRateBoxB1 | Regional Rate Box B1 | 12.25 x 10.50 x 5.50 in|\n| USPS_RegionalRateBoxB2 | Regional Rate Box B2 | 16.25 x 14.50 x 3.00 in|\n| USPS_SmallFlatRateBox | Small Flat Rate Box | 8.69 x 5.44 x 1.75 in|\n| USPS_SmallFlatRateEnvelope | Small Flat Rate Envelope | 10.00 x 6.00 x 4.00 in|\n\n## Other Carriers\nAdditional parcel templates are available for DHL eCommerce, DPD UK, and Aramex Australia.\nSee the Schemas section for complete template lists.\n" }, { "name": "Shippo Accounts", "description": "Shippo Accounts are used by Shippo Platform Accounts to create and manage Managed Shippo Accounts. \nManaged 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. \nThey 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." }, { "name": "Customs Declaration B13A Filing Option", "description": "B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). \nMore information on reporting commercial exports from Canada.\n\n**Allowed values:**\n- `FILED_ELECTRONICALLY`\n- `SUMMARY_REPORTING`\n- `NOT_REQUIRED`\n" }, { "name": "Customs Declaration Contents Type", "description": "Type of goods of the shipment.\n\n**Allowed values:**\n- `DOCUMENTS`\n- `GIFT`\n- `SAMPLE`\n- `MERCHANDISE`\n- `HUMANITARIAN_DONATION`\n- `RETURN_MERCHANDISE`\n- `OTHER`\n" }, { "name": "Customs Declaration EEL/PFC", "description": "EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; \nfor most other shipments from the US, `NOEEI_30_37_a` is applicable.\n\n**Allowed values:**\n- `NOEEI_30_37_a`\n- `NOEEI_30_37_h`\n- `NOEEI_30_37_f`\n- `NOEEI_30_36`\n- `AES_ITN`\n" }, { "name": "Customs Declaration Incoterm", "description": "The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. \neDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.\nIf expecting DAP for other carriers, please use DDU.\n\n**Allowed values:**\n- `DDP`\n- `DDU`\n- `FCA`\n- `DAP`\n- `eDAP`\n" }, { "name": "Customs Declaration Non Delivery Option", "description": "Indicates how the carrier should proceed in case the shipment can't be delivered.\n\n**Allowed values:**\n- `ABANDON`\n- `RETURN`\n" }, { "name": "Address Validation Source", "description": "Source of the address validation message.\n\n**Allowed values:**\n- `Shippo Address Validator`\n- `UPS`\n" }, { "name": "Address Validation Codes", "description": "Validation result codes returned by the address validation service.\n\n**Allowed values:**\n- `verification_error`\n- `unknown_street`\n- `component_mismatch_error`\n- `multiple_match`\n- `sub_premise_number_invalid`\n- `sub_premise_number_missing`\n- `premise_number_invalid`\n- `premise_number_missing`\n- `box_number_invalid`\n- `box_number_missing`\n- `pmb_number_missing`\n- `postal_code_change`\n- `administrative_area_change`\n- `locality_change`\n- `dependent_locality_change`\n- `street_name_change`\n- `street_type_change`\n- `street_directional_change`\n- `sub_premise_type_change`\n- `sub_premise_number_change`\n- `double_dependent_locality_change`\n- `subadministrative_area_change`\n- `subnational_area_change`\n- `po_box_change`\n- `premise_type_change`\n- `house_number_change`\n- `organization_change`\n- `extraneous_information`\n- `usps_door_inaccessible`\n- `administrative_area_partial`\n- `city_partial`\n- `street_partial`\n- `building_partial`\n- `subpremise_partial`\n- `administrative_area_full`\n- `city_full`\n- `thoroughfare_full`\n- `premises_full`\n- `subpremise_full`\n- `geocoded_street`\n- `geocoded_neighborhood`\n- `geocoded_community`\n- `geocoded_state`\n- `geocoded_rooftop`\n- `geocoded_interpolated_rooftop`\n- `invalid_postal_code`\n- `postal_code_not_found`\n- `empty_request`\n- `service_error`\n- `street_detail_missing`\n- `Invalid City/State/Zip`\n- `Default Match`\n- `Unknown Street`\n- `Address Not Found`\n- `Non-Deliverable ZIP4`\n- `Multiple Responses`\n- `Invalid Dual Address`\n- `Invalid State`\n- `Invalid City`\n- `Ambiguous Address`\n" } ], "x-tagGroups": [ { "name": "API", "tags": [ "Overview" ] }, { "name": "Addresses", "tags": [ "Addresses" ] }, { "name": "Parcels", "tags": [ "Parcels", "Carrier Parcel Templates", "User Parcel Templates" ] }, { "name": "Shipments", "tags": [ "Shipments", "Rates" ] }, { "name": "Purchase", "tags": [ "Transactions", "Batches" ] }, { "name": "Tracking", "tags": [ "Tracking Status" ] }, { "name": "Webhooks", "tags": [ "Webhooks" ] }, { "name": "International Shipping", "tags": [ "Customs Items", "Customs Declarations" ] }, { "name": "Carriers", "tags": [ "Carrier Accounts" ] }, { "name": "Manifests and pickups", "tags": [ "Manifests", "Pickups" ] }, { "name": "Orders", "tags": [ "Orders" ] }, { "name": "Billing", "tags": [ "Refunds" ] }, { "name": "Rates at Checkout", "tags": [ "Service Groups", "Rates at Checkout" ] }, { "name": "Accounts", "tags": [ "Shippo Accounts" ] }, { "name": "Enums", "tags": [ "Carriers", "Service Levels", "Parcel Templates", "Address Validation Source", "Address Validation Codes", "Customs Declaration B13A Filing Option", "Customs Declaration Contents Type", "Customs Declaration EEL/PFC", "Customs Declaration Incoterm", "Customs Declaration Non Delivery Option" ] } ], "paths": { "/addresses": { "get": { "description": "Returns a list of all address objects that have been created in this account.", "operationId": "ListAddresses", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageDefault5QueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/addressPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all addresses", "tags": [ "Addresses" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/addresses/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.addresses.list(page=1, results=5)\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.addresses.list(1, 5);\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->addresses->list(\n page: 1,\n results: 5,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->addressPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Addresses.ListAsync(\n page: 1,\n results: 5,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListAddressesResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListAddressesResponse res = sdk.addresses().list()\n .page(1L)\n .results(5L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.addressPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new address object. You can use address objects to create new shipments, calculate rates, and to create orders.", "operationId": "CreateAddress", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressCreateRequest" } } }, "description": "Address details." }, "responses": { "201": { "$ref": "#/components/responses/addressResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new address", "tags": [ "Addresses" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/addresses/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n -d name=\"Shawn Ippotle\" \\\n -d company=\"Shippo\" \\\n -d street1=\"215 Clayton St.\" \\\n -d street2=\"\" \\\n -d city=\"San Francisco\" \\\n -d state=\"CA\" \\\n -d zip=94117 \\\n -d country=\"US\" \\\n -d phone=\"+1 555 341 9393\" \\\n -d email=\"shippotle@shippo.com\"\\\n -d is_residential=True\\\n -d metadata=\"Customer ID 123456\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.addresses.create(request=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.addresses.create({\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$addressCreateRequest = new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n);\n\n$response = $sdk->addresses->create(\n addressCreateRequest: $addressCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->address !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Addresses.CreateAsync(\n addressCreateRequest: new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.operations.CreateAddressResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateAddressResponse res = sdk.addresses().create()\n .shippoApiVersion(\"2018-02-08\")\n .addressCreateRequest(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build())\n .call();\n\n if (res.address().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/addresses/{AddressId}": { "get": { "description": "Returns an existing address using an object ID.", "operationId": "GetAddress", "parameters": [ { "description": "Object ID of the address", "in": "path", "name": "AddressId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/addressResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve an address", "tags": [ "Addresses" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/addresses/d799c2679e644279b59fe661ac8fa488/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.addresses.get(address_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.addresses.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->addresses->get(\n addressId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->address !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Addresses.GetAsync(\n addressId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetAddressResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetAddressResponse res = sdk.addresses().get()\n .addressId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.address().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/addresses/{AddressId}/validate": { "get": { "description": "Validates an existing address using an object ID", "operationId": "ValidateAddress", "parameters": [ { "description": "Object ID of the address", "in": "path", "name": "AddressId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/addressResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Validate an address", "tags": [ "Addresses" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/addresses/d799c2679e644279b59fe661ac8fa488/validate/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.addresses.validate(address_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.addresses.validate(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->addresses->validate(\n addressId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->address !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Addresses.ValidateAsync(\n addressId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ValidateAddressResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ValidateAddressResponse res = sdk.addresses().validate()\n .addressId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.address().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "validate" } }, "/batches": { "post": { "description": "Creates a new batch object for purchasing shipping labels for many shipments at once. Batches are created asynchronously. This means that the API response won't include your batch shipments yet. You need to retrieve the batch later to verify that all batch shipments are valid.", "operationId": "CreateBatch", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BatchCreateRequest" } } }, "description": "Batch details." }, "responses": { "201": { "$ref": "#/components/responses/batchResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a batch", "tags": [ "Batches" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/batches/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"default_carrier_account\": \"078870331023437cb917f5187429b093\",\n \"default_servicelevel_token\": \"usps_priority\",\n \"label_filetype\": \"PDF_4x6\",\n \"metadata\": \"BATCH #170\",\n \"batch_shipments\": [\n {\n \"shipment\": { \n \"address_from\": {\n \"name\": \"Mr Hippo\",\n \"street1\": \"965 Mission St\",\n \"street2\": \"Ste 201\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n \"email\": \"mrhippo@shippo.com\"\n },\n \"address_to\": {\n \"name\": \"Mrs Hippo\",\n \"company\": \"\",\n \"street1\": \"Broadway 1\",\n \"street2\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10007\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n \"email\": \"mrshippo@shippo.com\"\n },\n \"parcels\": [{\n \"length\": \"5\",\n \"width\": \"5\",\n \"height\": \"5\",\n \"distance_unit\": \"in\",\n \"weight\": \"2\",\n \"mass_unit\": \"oz\"\n }]\n }\n },\n {\n \"shipment\": { \n \"address_from\": {\n \"name\": \"Mr Hippo\",\n \"street1\": \"1092 Indian Summer Ct\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zip\": \"95122\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n \"email\": \"mrhippo@shippo.com\"\n },\n \"address_to\": {\n \"name\": \"Mrs Hippo\",\n \"company\": \"\",\n \"street1\": \"Broadway 1\",\n \"street2\": \"\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10007\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n \"email\": \"mrshippo@shippo.com\"\n },\n \"parcels\": [{\n \"length\": \"5\",\n \"width\": \"5\",\n \"height\": \"5\",\n \"distance_unit\": \"in\",\n \"weight\": \"20\",\n \"mass_unit\": \"lb\"\n }]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"servicelevel_token\": \"fedex_2_day\"\n }\n ]\n }' " }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.batches.create(request=components.BatchCreateRequest(\n default_carrier_account='078870331023437cb917f5187429b093',\n default_servicelevel_token='usps_priority',\n label_filetype=components.LabelFileTypeEnum.PDF_4X6,\n metadata='BATCH #1',\n batch_shipments=[\n components.BatchShipmentCreateRequest(\n carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata='SHIPMENT #1',\n servicelevel_token='fedex_ground',\n shipment=components.ShipmentCreateRequest(\n extra=components.ShipmentExtra(\n accounts_receivable_customer_account=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n appropriation_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n bill_of_lading_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n cod_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n customer_reference=components.CustomerReference(\n ref_sort=1,\n ),\n dealer_order_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n dept_number=components.DepartmentNumber(\n ref_sort=3,\n ),\n fda_product_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n insurance=components.Insurance(\n amount='5.5',\n currency='USD',\n ),\n invoice_number=components.InvoiceNumber(\n ref_sort=2,\n ),\n manifest_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n model_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n part_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n po_number=components.PoNumber(\n ref_sort=2,\n ),\n production_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n purchase_request_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n rma_number=components.RmaNumber(\n ref_sort=1,\n ),\n salesperson_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n serial_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n store_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n transaction_reference_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n ),\n metadata='Customer ID 123456',\n shipment_date='2021-03-22T12:00:00Z',\n address_from='d799c2679e644279b59fe661ac8fa488',\n address_return=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_to=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n customs_declaration=components.CustomsDeclarationCreateRequest(\n b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,\n certify=True,\n certify_signer='Shawn Ippotle',\n contents_explanation='T-Shirt purchase',\n duties_payor=components.DutiesPayor(\n account='2323434543',\n type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,\n address=components.CustomsDeclarationCreateRequestAddress(\n name='Patrick Kavanagh',\n zip='80331',\n country='DE',\n ),\n ),\n exporter_identification=components.CustomsExporterIdentification(\n eori_number='PL123456790ABCDE',\n tax_id=components.CustomsTaxIdentification(\n number='123456789',\n type=components.CustomsTaxIdentificationType.EIN,\n ),\n ),\n invoice='#123123',\n metadata='Order ID #123123',\n address_importer=components.AddressImporter(\n name='Shwan Ippotle',\n company='Shippo',\n street1='Blumenstraße',\n street3='',\n street_no='22',\n city='München',\n state='CA',\n zip='80331',\n country='DE',\n phone='80331',\n email='shippotle@shippo.com',\n is_residential=True,\n ),\n contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,\n eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,\n incoterm=components.CustomsDeclarationIncotermEnum.DDP,\n items=[\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n ],\n non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,\n test=True,\n ),\n carrier_accounts=[\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels=[\n components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n ),\n components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n ),\n components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n ),\n ],\n ),\n ),\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.batches.create({\n defaultCarrierAccount: \"078870331023437cb917f5187429b093\",\n defaultServicelevelToken: \"usps_priority\",\n labelFiletype: \"PDF_4x6\",\n metadata: \"BATCH #1\",\n batchShipments: [\n {\n carrierAccount: \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n metadata: \"SHIPMENT #1\",\n servicelevelToken: \"fedex_ground\",\n shipment: {\n extra: {\n accountsReceivableCustomerAccount: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n appropriationNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n billOfLadingNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n codNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n customerReference: {\n refSort: 1,\n },\n dealerOrderNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n deptNumber: {\n refSort: 3,\n },\n fdaProductCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n insurance: {\n amount: \"5.5\",\n currency: \"USD\",\n },\n invoiceNumber: {\n refSort: 2,\n },\n manifestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n modelNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n partNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n poNumber: {\n refSort: 2,\n },\n productionCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n purchaseRequestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n rmaNumber: {\n refSort: 1,\n },\n salespersonNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n serialNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n storeNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n transactionReferenceNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n },\n metadata: \"Customer ID 123456\",\n shipmentDate: \"2021-03-22T12:00:00Z\",\n addressFrom: \"d799c2679e644279b59fe661ac8fa488\",\n addressReturn: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n customsDeclaration: {\n b13aFilingOption: \"FILED_ELECTRONICALLY\",\n certify: true,\n certifySigner: \"Shawn Ippotle\",\n contentsExplanation: \"T-Shirt purchase\",\n dutiesPayor: {\n account: \"2323434543\",\n type: \"THIRD_PARTY\",\n address: {\n name: \"Patrick Kavanagh\",\n zip: \"80331\",\n country: \"DE\",\n },\n },\n exporterIdentification: {\n eoriNumber: \"PL123456790ABCDE\",\n taxId: {\n number: \"123456789\",\n type: \"EIN\",\n },\n },\n invoice: \"#123123\",\n metadata: \"Order ID #123123\",\n addressImporter: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"Blumenstraße\",\n street3: \"\",\n streetNo: \"22\",\n city: \"München\",\n state: \"CA\",\n zip: \"80331\",\n country: \"DE\",\n phone: \"80331\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n },\n contentsType: \"MERCHANDISE\",\n eelPfc: \"NOEEI_30_37_a\",\n incoterm: \"DDP\",\n items: [\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n ],\n nonDeliveryOption: \"RETURN\",\n test: true,\n },\n carrierAccounts: [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n ],\n parcels: [\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n },\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n },\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n },\n ],\n },\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$batchCreateRequest = new Components\\BatchCreateRequest(\n defaultCarrierAccount: '078870331023437cb917f5187429b093',\n defaultServicelevelToken: 'usps_priority',\n labelFiletype: Components\\LabelFileTypeEnum::PDF4x6,\n metadata: 'BATCH #1',\n batchShipments: [\n new Components\\BatchShipmentCreateRequest(\n carrierAccount: 'a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata: 'SHIPMENT #1',\n servicelevelToken: 'fedex_ground',\n shipment: new Components\\ShipmentCreateRequest(\n extra: new Components\\ShipmentExtra(\n accountsReceivableCustomerAccount: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n appropriationNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n billOfLadingNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n codNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n customerReference: new Components\\CustomerReference(\n refSort: 1,\n ),\n dealerOrderNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n deptNumber: new Components\\DepartmentNumber(\n refSort: 3,\n ),\n fdaProductCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n insurance: new Components\\Insurance(\n amount: '5.5',\n currency: 'USD',\n ),\n invoiceNumber: new Components\\InvoiceNumber(\n refSort: 2,\n ),\n manifestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n modelNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n partNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n poNumber: new Components\\PoNumber(\n refSort: 2,\n ),\n productionCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n purchaseRequestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n rmaNumber: new Components\\RmaNumber(\n refSort: 1,\n ),\n salespersonNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n serialNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n storeNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n transactionReferenceNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n ),\n metadata: 'Customer ID 123456',\n shipmentDate: '2021-03-22T12:00:00Z',\n addressFrom: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n addressReturn: 'd799c2679e644279b59fe661ac8fa488',\n addressTo: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n customsDeclaration: new Components\\CustomsDeclarationCreateRequest(\n b13aFilingOption: Components\\CustomsDeclarationB13AFilingOptionEnum::FiledElectronically,\n certify: true,\n certifySigner: 'Shawn Ippotle',\n contentsExplanation: 'T-Shirt purchase',\n dutiesPayor: new Components\\DutiesPayor(\n account: '2323434543',\n type: Components\\CustomsDeclarationCreateRequestType::ThirdParty,\n address: new Components\\CustomsDeclarationCreateRequestAddress(\n name: 'Patrick Kavanagh',\n zip: '80331',\n country: 'DE',\n ),\n ),\n exporterIdentification: new Components\\CustomsExporterIdentification(\n eoriNumber: 'PL123456790ABCDE',\n taxId: new Components\\CustomsTaxIdentification(\n number: '123456789',\n type: Components\\CustomsTaxIdentificationType::Ein,\n ),\n ),\n invoice: '#123123',\n metadata: 'Order ID #123123',\n addressImporter: new Components\\AddressImporter(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: 'Blumenstraße',\n street3: '',\n streetNo: '22',\n city: 'München',\n state: 'CA',\n zip: '80331',\n country: 'DE',\n phone: '80331',\n email: 'shippotle@shippo.com',\n isResidential: true,\n ),\n contentsType: Components\\CustomsDeclarationContentsTypeEnum::Merchandise,\n eelPfc: Components\\CustomsDeclarationEelPfcEnum::NOEEI3037A,\n incoterm: Components\\CustomsDeclarationIncotermEnum::Ddp,\n items: [\n new Components\\CustomsItemCreateRequest(\n description: 'T-Shirt',\n massUnit: Components\\WeightUnitEnum::Lb,\n metadata: 'Order ID \"123454\"',\n netWeight: '5',\n originCountry: '',\n quantity: 20,\n skuCode: 'HM-123',\n hsCode: '0901.21',\n valueAmount: '200',\n valueCurrency: 'USD',\n ),\n ],\n nonDeliveryOption: Components\\CustomsDeclarationNonDeliveryOptionEnum::Return,\n test: true,\n ),\n carrierAccounts: [\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels: [\n new Components\\ParcelCreateRequest(\n extra: new Components\\ParcelExtra(\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n insurance: new Components\\ParcelInsurance(\n amount: '5.5',\n content: 'Laptop',\n currency: 'USD',\n provider: Components\\ParcelInsuranceProvider::Ups,\n ),\n ),\n metadata: 'Customer ID 123456',\n massUnit: Components\\WeightUnitEnum::Lb,\n weight: '1',\n distanceUnit: Components\\DistanceUnitEnum::In,\n height: '1',\n length: '1',\n width: '1',\n ),\n ],\n ),\n ),\n ],\n);\n\n$response = $sdk->batches->create(\n batchCreateRequest: $batchCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->batch !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Batches.CreateAsync(\n batchCreateRequest: new BatchCreateRequest() {\n DefaultCarrierAccount = \"078870331023437cb917f5187429b093\",\n DefaultServicelevelToken = \"usps_priority\",\n LabelFiletype = LabelFileTypeEnum.Pdf4x6,\n Metadata = \"BATCH #1\",\n BatchShipments = new List() {\n new BatchShipmentCreateRequest() {\n CarrierAccount = \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n Metadata = \"SHIPMENT #1\",\n ServicelevelToken = \"fedex_ground\",\n Shipment = new ShipmentCreateRequest() {\n Extra = new ShipmentExtra() {\n AccountsReceivableCustomerAccount = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n AppropriationNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n BillOfLadingNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n CodNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n CustomerReference = new CustomerReference() {\n RefSort = 1,\n },\n DealerOrderNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n DeptNumber = new DepartmentNumber() {\n RefSort = 3,\n },\n FdaProductCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Insurance = new Insurance() {\n Amount = \"5.5\",\n Currency = \"USD\",\n },\n InvoiceNumber = new InvoiceNumber() {\n RefSort = 2,\n },\n ManifestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n ModelNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PartNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PoNumber = new PoNumber() {\n RefSort = 2,\n },\n ProductionCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PurchaseRequestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n RmaNumber = new RmaNumber() {\n RefSort = 1,\n },\n SalespersonNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n SerialNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n StoreNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n TransactionReferenceNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n },\n Metadata = \"Customer ID 123456\",\n ShipmentDate = \"2021-03-22T12:00:00Z\",\n AddressFrom = AddressFrom.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n AddressReturn = AddressReturn.CreateStr(\n \"d799c2679e644279b59fe661ac8fa488\"\n ),\n AddressTo = AddressTo.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n CustomsDeclaration = ShipmentCreateRequestCustomsDeclaration.CreateCustomsDeclarationCreateRequest(\n new CustomsDeclarationCreateRequest() {\n B13aFilingOption = CustomsDeclarationB13AFilingOptionEnum.FiledElectronically,\n Certify = true,\n CertifySigner = \"Shawn Ippotle\",\n ContentsExplanation = \"T-Shirt purchase\",\n DutiesPayor = new DutiesPayor() {\n Account = \"2323434543\",\n Type = CustomsDeclarationCreateRequestType.ThirdParty,\n Address = new CustomsDeclarationCreateRequestAddress() {\n Name = \"Patrick Kavanagh\",\n Zip = \"80331\",\n Country = \"DE\",\n },\n },\n ExporterIdentification = new CustomsExporterIdentification() {\n EoriNumber = \"PL123456790ABCDE\",\n TaxId = new CustomsTaxIdentification() {\n Number = \"123456789\",\n Type = CustomsTaxIdentificationType.Ein,\n },\n },\n Invoice = \"#123123\",\n Metadata = \"Order ID #123123\",\n AddressImporter = new AddressImporter() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"Blumenstraße\",\n Street3 = \"\",\n StreetNo = \"22\",\n City = \"München\",\n State = \"CA\",\n Zip = \"80331\",\n Country = \"DE\",\n Phone = \"80331\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n },\n ContentsType = CustomsDeclarationContentsTypeEnum.Merchandise,\n EelPfc = CustomsDeclarationEelPfcEnum.Noeei3037A,\n Incoterm = CustomsDeclarationIncotermEnum.Ddp,\n Items = new List() {\n new CustomsItemCreateRequest() {\n Description = \"T-Shirt\",\n MassUnit = WeightUnitEnum.Lb,\n Metadata = \"Order ID \\\"123454\\\"\",\n NetWeight = \"5\",\n OriginCountry = \"\",\n Quantity = 20,\n SkuCode = \"HM-123\",\n HsCode = \"0901.21\",\n ValueAmount = \"200\",\n ValueCurrency = \"USD\",\n },\n },\n NonDeliveryOption = CustomsDeclarationNonDeliveryOptionEnum.Return,\n Test = true,\n }\n ),\n CarrierAccounts = new List() {\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n },\n Parcels = new List() {\n Parcels.CreateParcelCreateRequest(\n new ParcelCreateRequest() {\n Extra = new ParcelExtra() {\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n Insurance = new ParcelInsurance() {\n Amount = \"5.5\",\n Content = \"Laptop\",\n Currency = \"USD\",\n Provider = ParcelInsuranceProvider.Ups,\n },\n },\n Metadata = \"Customer ID 123456\",\n MassUnit = WeightUnitEnum.Lb,\n Weight = \"1\",\n DistanceUnit = DistanceUnitEnum.In,\n Height = \"1\",\n Length = \"1\",\n Width = \"1\",\n }\n ),\n },\n },\n },\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.AddressFrom;\nimport com.goshippo.shippo_sdk.models.components.AddressImporter;\nimport com.goshippo.shippo_sdk.models.components.AddressReturn;\nimport com.goshippo.shippo_sdk.models.components.AddressTo;\nimport com.goshippo.shippo_sdk.models.components.BatchCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.Cod;\nimport com.goshippo.shippo_sdk.models.components.CustomerReference;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;\nimport com.goshippo.shippo_sdk.models.components.DepartmentNumber;\nimport com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;\nimport com.goshippo.shippo_sdk.models.components.DutiesPayor;\nimport com.goshippo.shippo_sdk.models.components.Insurance;\nimport com.goshippo.shippo_sdk.models.components.InvoiceNumber;\nimport com.goshippo.shippo_sdk.models.components.LabelFileTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.ParcelCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ParcelExtra;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsurance;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;\nimport com.goshippo.shippo_sdk.models.components.Parcels;\nimport com.goshippo.shippo_sdk.models.components.PaymentMethod;\nimport com.goshippo.shippo_sdk.models.components.PoNumber;\nimport com.goshippo.shippo_sdk.models.components.RmaNumber;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;\nimport com.goshippo.shippo_sdk.models.components.ShipmentExtra;\nimport com.goshippo.shippo_sdk.models.components.UPSReferenceFields;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateBatchResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateBatchResponse res = sdk.batches().create()\n .shippoApiVersion(\"2018-02-08\")\n .batchCreateRequest(BatchCreateRequest.builder()\n .defaultCarrierAccount(\"078870331023437cb917f5187429b093\")\n .defaultServicelevelToken(\"usps_priority\")\n .batchShipments(List.of(\n BatchShipmentCreateRequest.builder()\n .shipment(ShipmentCreateRequest.builder()\n .addressFrom(AddressFrom.of(\"d799c2679e644279b59fe661ac8fa488\"))\n .addressTo(AddressTo.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .parcels(List.of(\n Parcels.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build()),\n Parcels.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build()),\n Parcels.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build())))\n .extra(ShipmentExtra.builder()\n .accountsReceivableCustomerAccount(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .appropriationNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .billOfLadingNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .codNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .customerReference(CustomerReference.builder()\n .refSort(1L)\n .build())\n .dealerOrderNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .deptNumber(DepartmentNumber.builder()\n .refSort(3L)\n .build())\n .fdaProductCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .insurance(Insurance.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .build())\n .invoiceNumber(InvoiceNumber.builder()\n .refSort(2L)\n .build())\n .manifestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .modelNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .partNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .poNumber(PoNumber.builder()\n .refSort(2L)\n .build())\n .productionCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .purchaseRequestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .rmaNumber(RmaNumber.builder()\n .refSort(1L)\n .build())\n .salespersonNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .serialNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .storeNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .transactionReferenceNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .shipmentDate(\"2021-03-22T12:00:00Z\")\n .addressReturn(AddressReturn.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(CustomsDeclarationCreateRequest.builder()\n .certify(true)\n .certifySigner(\"Shawn Ippotle\")\n .contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)\n .items(List.of(\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build(),\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build(),\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build()))\n .nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)\n .b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)\n .contentsExplanation(\"T-Shirt purchase\")\n .dutiesPayor(DutiesPayor.builder()\n .account(\"2323434543\")\n .type(CustomsDeclarationCreateRequestType.THIRD_PARTY)\n .address(CustomsDeclarationCreateRequestAddress.builder()\n .name(\"Patrick Kavanagh\")\n .zip(\"80331\")\n .country(\"DE\")\n .build())\n .build())\n .exporterIdentification(CustomsExporterIdentification.builder()\n .eoriNumber(\"PL123456790ABCDE\")\n .taxId(CustomsTaxIdentification.builder()\n .number(\"123456789\")\n .type(CustomsTaxIdentificationType.EIN)\n .build())\n .build())\n .invoice(\"#123123\")\n .metadata(\"Order ID #123123\")\n .addressImporter(AddressImporter.builder()\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"Blumenstraße\")\n .street3(\"\")\n .streetNo(\"22\")\n .city(\"München\")\n .state(\"CA\")\n .zip(\"80331\")\n .country(\"DE\")\n .phone(\"80331\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .build())\n .eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)\n .incoterm(CustomsDeclarationIncotermEnum.DDP)\n .test(true)\n .build()))\n .carrierAccounts(List.of(\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"))\n .build())\n .carrierAccount(\"a4391cd4ab974f478f55dc08b5c8e3b3\")\n .metadata(\"SHIPMENT #1\")\n .servicelevelToken(\"fedex_ground\")\n .build()))\n .labelFiletype(LabelFileTypeEnum.PDF4X6)\n .metadata(\"BATCH #1\")\n .build())\n .call();\n\n if (res.batch().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/batches/{BatchId}": { "get": { "description": "Returns a batch using an object ID.
Batch shipments are displayed 100 at a time. You can iterate \nthrough each `page` using the `?page= query` parameter. You can also filter based on batch shipment \nstatus, for example, by passing a query param like `?object_results=creation_failed`.
\nFor more details on filtering results, see our guide on filtering.", "operationId": "GetBatch", "parameters": [ { "description": "Object ID of the batch", "in": "path", "name": "BatchId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageDefault5QueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/batchResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a batch", "tags": [ "Batches" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/batches/?page=2&object_results=creation_failed \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.batches.get(batch_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.batches.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\GetBatchRequest(\n batchId: '',\n);\n\n$response = $sdk->batches->get(\n request: $request\n);\n\nif ($response->batch !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nGetBatchRequest req = new GetBatchRequest() {\n BatchId = \"\",\n};\n\nvar res = await sdk.Batches.GetAsync(req);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetBatchResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetBatchResponse res = sdk.batches().get()\n .batchId(\"\")\n .page(1L)\n .results(5L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.batch().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/batches/{BatchId}/add_shipments": { "post": { "description": "Adds batch shipments to an existing batch.", "operationId": "AddShipmentsToBatch", "parameters": [ { "description": "Object ID of the batch", "in": "path", "name": "BatchId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/BatchShipmentCreateRequest" }, "type": "array" } } }, "description": "Array of shipments to add to the batch" }, "responses": { "200": { "$ref": "#/components/responses/batchResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Add shipments to a batch", "tags": [ "Batches" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X POST https://api.goshippo.com/batches//add_shipments \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '[\n {\n \"shipment\": { \n \"address_from\": {\n \"name\": \"Mr Hippo\",\n \"street1\": \"965 Mission St\",\n \"street2\": \"Ste 201\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n },\n \"address_to\": {\n \"name\": \"Hippo Jr\",\n \"street1\": \"915 Broadway\",\n \"street2\": \"19th Floor\",\n \"city\": \"New York\",\n \"state\": \"NY\",\n \"zip\": \"10010\",\n \"country\": \"US\",\n \"phone\": \"2129947880\",\n },\n \"parcels\": [{\n \"length\": \"12\",\n \"width\": \"12\",\n \"height\": \"12\",\n \"distance_unit\": \"in\",\n \"weight\": \"12\",\n \"mass_unit\": \"oz\"\n }]\n }\n },\n {\n \"shipment\": { \n \"address_from\": {\n \"name\": \"Ms Hippo\",\n \"street1\": \"1092 Indian Summer Ct\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zip\": \"95122\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n },\n \"address_to\": {\n \"name\": \"Mr Hippo\",\n \"street1\": \"965 Mission St\",\n \"street2\": \"Ste 201\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n },\n \"parcels\": [{\n \"length\": \"5\",\n \"width\": \"5\",\n \"height\": \"5\",\n \"distance_unit\": \"in\",\n \"weight\": \"2\",\n \"mass_unit\": \"lb\"\n }]\n },\n \"carrier_account\": \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n \"servicelevel_token\": \"fedex_2_day\"\n }\n ]'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.batches.add_shipments(request_body=[\n components.BatchShipmentCreateRequest(\n carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata='SHIPMENT #1',\n servicelevel_token='fedex_ground',\n shipment=components.ShipmentCreateRequest(\n extra=components.ShipmentExtra(\n accounts_receivable_customer_account=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n appropriation_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n bill_of_lading_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n cod_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n customer_reference=components.CustomerReference(\n ref_sort=1,\n ),\n dealer_order_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n dept_number=components.DepartmentNumber(\n ref_sort=3,\n ),\n fda_product_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n insurance=components.Insurance(\n amount='5.5',\n currency='USD',\n ),\n invoice_number=components.InvoiceNumber(\n ref_sort=2,\n ),\n manifest_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n model_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n part_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n po_number=components.PoNumber(\n ref_sort=2,\n ),\n production_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n purchase_request_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n rma_number=components.RmaNumber(\n ref_sort=1,\n ),\n salesperson_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n serial_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n store_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n transaction_reference_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n ),\n metadata='Customer ID 123456',\n shipment_date='2021-03-22T12:00:00Z',\n address_from=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_return=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_to='d799c2679e644279b59fe661ac8fa489',\n customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',\n carrier_accounts=[\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels=[\n '',\n '',\n components.ParcelCreateFromTemplateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n template=components.ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE,\n ),\n ],\n ),\n ),\n components.BatchShipmentCreateRequest(\n carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata='SHIPMENT #1',\n servicelevel_token='fedex_ground',\n shipment=components.ShipmentCreateRequest(\n extra=components.ShipmentExtra(\n accounts_receivable_customer_account=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n appropriation_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n bill_of_lading_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n cod_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n customer_reference=components.CustomerReference(\n ref_sort=1,\n ),\n dealer_order_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n dept_number=components.DepartmentNumber(\n ref_sort=3,\n ),\n fda_product_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n insurance=components.Insurance(\n amount='5.5',\n currency='USD',\n ),\n invoice_number=components.InvoiceNumber(\n ref_sort=2,\n ),\n manifest_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n model_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n part_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n po_number=components.PoNumber(\n ref_sort=2,\n ),\n production_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n purchase_request_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n rma_number=components.RmaNumber(\n ref_sort=1,\n ),\n salesperson_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n serial_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n store_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n transaction_reference_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n ),\n metadata='Customer ID 123456',\n shipment_date='2021-03-22T12:00:00Z',\n address_from=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_return=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_to=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n customs_declaration=components.CustomsDeclarationCreateRequest(\n b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,\n certify=True,\n certify_signer='Shawn Ippotle',\n contents_explanation='T-Shirt purchase',\n duties_payor=components.DutiesPayor(\n account='2323434543',\n type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,\n address=components.CustomsDeclarationCreateRequestAddress(\n name='Patrick Kavanagh',\n zip='80331',\n country='DE',\n ),\n ),\n exporter_identification=components.CustomsExporterIdentification(\n eori_number='PL123456790ABCDE',\n tax_id=components.CustomsTaxIdentification(\n number='123456789',\n type=components.CustomsTaxIdentificationType.EIN,\n ),\n ),\n invoice='#123123',\n metadata='Order ID #123123',\n address_importer=components.AddressImporter(\n name='Shwan Ippotle',\n company='Shippo',\n street1='Blumenstraße',\n street3='',\n street_no='22',\n city='München',\n state='CA',\n zip='80331',\n country='DE',\n phone='80331',\n email='shippotle@shippo.com',\n is_residential=True,\n ),\n contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,\n eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,\n incoterm=components.CustomsDeclarationIncotermEnum.DDP,\n items=[\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n ],\n non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,\n test=True,\n ),\n carrier_accounts=[\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels=[\n components.ParcelCreateFromTemplateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n template=components.ParcelTemplateDPDUKEnum.DPD_UK_EXPRESS_PAK,\n ),\n components.ParcelCreateFromTemplateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n template=components.ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR,\n ),\n ],\n ),\n ),\n components.BatchShipmentCreateRequest(\n carrier_account='a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata='SHIPMENT #1',\n servicelevel_token='fedex_ground',\n shipment=components.ShipmentCreateRequest(\n extra=components.ShipmentExtra(\n accounts_receivable_customer_account=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n appropriation_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n bill_of_lading_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n cod_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n customer_reference=components.CustomerReference(\n ref_sort=1,\n ),\n dealer_order_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n dept_number=components.DepartmentNumber(\n ref_sort=3,\n ),\n fda_product_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n insurance=components.Insurance(\n amount='5.5',\n currency='USD',\n ),\n invoice_number=components.InvoiceNumber(\n ref_sort=2,\n ),\n manifest_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n model_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n part_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n po_number=components.PoNumber(\n ref_sort=2,\n ),\n production_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n purchase_request_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n rma_number=components.RmaNumber(\n ref_sort=1,\n ),\n salesperson_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n serial_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n store_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n transaction_reference_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n ),\n metadata='Customer ID 123456',\n shipment_date='2021-03-22T12:00:00Z',\n address_from='d799c2679e644279b59fe661ac8fa488',\n address_return='d799c2679e644279b59fe661ac8fa488',\n address_to=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n customs_declaration='adcfdddf8ec64b84ad22772bce3ea37a',\n carrier_accounts=[\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels=[\n '',\n ],\n ),\n ),\n], batch_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.batches.addShipments([\n {\n carrierAccount: \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n metadata: \"SHIPMENT #1\",\n servicelevelToken: \"fedex_ground\",\n shipment: {\n extra: {\n accountsReceivableCustomerAccount: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n appropriationNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n billOfLadingNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n codNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n customerReference: {\n refSort: 1,\n },\n dealerOrderNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n deptNumber: {\n refSort: 3,\n },\n fdaProductCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n insurance: {\n amount: \"5.5\",\n currency: \"USD\",\n },\n invoiceNumber: {\n refSort: 2,\n },\n manifestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n modelNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n partNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n poNumber: {\n refSort: 2,\n },\n productionCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n purchaseRequestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n rmaNumber: {\n refSort: 1,\n },\n salespersonNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n serialNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n storeNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n transactionReferenceNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n },\n metadata: \"Customer ID 123456\",\n shipmentDate: \"2021-03-22T12:00:00Z\",\n addressFrom: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressReturn: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressTo: \"d799c2679e644279b59fe661ac8fa489\",\n customsDeclaration: \"adcfdddf8ec64b84ad22772bce3ea37a\",\n carrierAccounts: [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n ],\n parcels: [\n \"\",\n \"\",\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n template: \"USPS_SmallFlatRateEnvelope\",\n },\n ],\n },\n },\n {\n carrierAccount: \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n metadata: \"SHIPMENT #1\",\n servicelevelToken: \"fedex_ground\",\n shipment: {\n extra: {\n accountsReceivableCustomerAccount: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n appropriationNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n billOfLadingNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n codNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n customerReference: {\n refSort: 1,\n },\n dealerOrderNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n deptNumber: {\n refSort: 3,\n },\n fdaProductCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n insurance: {\n amount: \"5.5\",\n currency: \"USD\",\n },\n invoiceNumber: {\n refSort: 2,\n },\n manifestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n modelNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n partNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n poNumber: {\n refSort: 2,\n },\n productionCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n purchaseRequestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n rmaNumber: {\n refSort: 1,\n },\n salespersonNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n serialNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n storeNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n transactionReferenceNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n },\n metadata: \"Customer ID 123456\",\n shipmentDate: \"2021-03-22T12:00:00Z\",\n addressFrom: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressReturn: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n customsDeclaration: {\n b13aFilingOption: \"FILED_ELECTRONICALLY\",\n certify: true,\n certifySigner: \"Shawn Ippotle\",\n contentsExplanation: \"T-Shirt purchase\",\n dutiesPayor: {\n account: \"2323434543\",\n type: \"THIRD_PARTY\",\n address: {\n name: \"Patrick Kavanagh\",\n zip: \"80331\",\n country: \"DE\",\n },\n },\n exporterIdentification: {\n eoriNumber: \"PL123456790ABCDE\",\n taxId: {\n number: \"123456789\",\n type: \"EIN\",\n },\n },\n invoice: \"#123123\",\n metadata: \"Order ID #123123\",\n addressImporter: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"Blumenstraße\",\n street3: \"\",\n streetNo: \"22\",\n city: \"München\",\n state: \"CA\",\n zip: \"80331\",\n country: \"DE\",\n phone: \"80331\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n },\n contentsType: \"MERCHANDISE\",\n eelPfc: \"NOEEI_30_37_a\",\n incoterm: \"DDP\",\n items: [\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n ],\n nonDeliveryOption: \"RETURN\",\n test: true,\n },\n carrierAccounts: [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n ],\n parcels: [\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n template: \"DPD_UK_Express_Pak\",\n },\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n template: \"DHLeC_Irregular\",\n },\n ],\n },\n },\n {\n carrierAccount: \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n metadata: \"SHIPMENT #1\",\n servicelevelToken: \"fedex_ground\",\n shipment: {\n extra: {\n accountsReceivableCustomerAccount: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n appropriationNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n billOfLadingNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n codNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n customerReference: {\n refSort: 1,\n },\n dealerOrderNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n deptNumber: {\n refSort: 3,\n },\n fdaProductCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n insurance: {\n amount: \"5.5\",\n currency: \"USD\",\n },\n invoiceNumber: {\n refSort: 2,\n },\n manifestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n modelNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n partNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n poNumber: {\n refSort: 2,\n },\n productionCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n purchaseRequestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n rmaNumber: {\n refSort: 1,\n },\n salespersonNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n serialNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n storeNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n transactionReferenceNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n },\n metadata: \"Customer ID 123456\",\n shipmentDate: \"2021-03-22T12:00:00Z\",\n addressFrom: \"d799c2679e644279b59fe661ac8fa488\",\n addressReturn: \"d799c2679e644279b59fe661ac8fa488\",\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n customsDeclaration: \"adcfdddf8ec64b84ad22772bce3ea37a\",\n carrierAccounts: [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n ],\n parcels: [\n \"\",\n ],\n },\n },\n ], \"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Batches.AddShipmentsAsync(\n batchId: \"\",\n requestBody: new List() {\n new BatchShipmentCreateRequest() {\n CarrierAccount = \"a4391cd4ab974f478f55dc08b5c8e3b3\",\n Metadata = \"SHIPMENT #1\",\n ServicelevelToken = \"fedex_ground\",\n Shipment = new ShipmentCreateRequest() {\n Extra = new ShipmentExtra() {\n AccountsReceivableCustomerAccount = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n AppropriationNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n BillOfLadingNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n CodNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n CustomerReference = new CustomerReference() {\n RefSort = 1,\n },\n DealerOrderNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n DeptNumber = new DepartmentNumber() {\n RefSort = 3,\n },\n FdaProductCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Insurance = new Insurance() {\n Amount = \"5.5\",\n Currency = \"USD\",\n },\n InvoiceNumber = new InvoiceNumber() {\n RefSort = 2,\n },\n ManifestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n ModelNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PartNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PoNumber = new PoNumber() {\n RefSort = 2,\n },\n ProductionCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PurchaseRequestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n RmaNumber = new RmaNumber() {\n RefSort = 1,\n },\n SalespersonNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n SerialNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n StoreNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n TransactionReferenceNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n },\n Metadata = \"Customer ID 123456\",\n ShipmentDate = \"2021-03-22T12:00:00Z\",\n AddressFrom = AddressFrom.CreateStr(\n \"d799c2679e644279b59fe661ac8fa488\"\n ),\n AddressReturn = AddressReturn.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n AddressTo = AddressTo.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n CustomsDeclaration = ShipmentCreateRequestCustomsDeclaration.CreateStr(\n \"adcfdddf8ec64b84ad22772bce3ea37a\"\n ),\n CarrierAccounts = new List() {\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n },\n Parcels = new List() {\n Parcels.CreateStr(\n \"\"\n ),\n },\n },\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->batches->addShipments(\n batchId: '',\n requestBody: [\n new Components\\BatchShipmentCreateRequest(\n carrierAccount: 'a4391cd4ab974f478f55dc08b5c8e3b3',\n metadata: 'SHIPMENT #1',\n servicelevelToken: 'fedex_ground',\n shipment: new Components\\ShipmentCreateRequest(\n extra: new Components\\ShipmentExtra(\n accountsReceivableCustomerAccount: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n appropriationNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n billOfLadingNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n codNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n customerReference: new Components\\CustomerReference(\n refSort: 1,\n ),\n dealerOrderNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n deptNumber: new Components\\DepartmentNumber(\n refSort: 3,\n ),\n fdaProductCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n insurance: new Components\\Insurance(\n amount: '5.5',\n currency: 'USD',\n ),\n invoiceNumber: new Components\\InvoiceNumber(\n refSort: 2,\n ),\n manifestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n modelNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n partNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n poNumber: new Components\\PoNumber(\n refSort: 2,\n ),\n productionCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n purchaseRequestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n rmaNumber: new Components\\RmaNumber(\n refSort: 1,\n ),\n salespersonNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n serialNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n storeNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n transactionReferenceNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n ),\n metadata: 'Customer ID 123456',\n shipmentDate: '2021-03-22T12:00:00Z',\n addressFrom: 'd799c2679e644279b59fe661ac8fa488',\n addressReturn: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n addressTo: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n customsDeclaration: 'adcfdddf8ec64b84ad22772bce3ea37a',\n carrierAccounts: [\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels: [\n '',\n ],\n ),\n ),\n ],\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->batch !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.AddressFrom;\nimport com.goshippo.shippo_sdk.models.components.AddressImporter;\nimport com.goshippo.shippo_sdk.models.components.AddressReturn;\nimport com.goshippo.shippo_sdk.models.components.AddressTo;\nimport com.goshippo.shippo_sdk.models.components.BatchShipmentCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.Cod;\nimport com.goshippo.shippo_sdk.models.components.CustomerReference;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;\nimport com.goshippo.shippo_sdk.models.components.DepartmentNumber;\nimport com.goshippo.shippo_sdk.models.components.DutiesPayor;\nimport com.goshippo.shippo_sdk.models.components.Insurance;\nimport com.goshippo.shippo_sdk.models.components.InvoiceNumber;\nimport com.goshippo.shippo_sdk.models.components.ParcelCreateFromTemplateRequest;\nimport com.goshippo.shippo_sdk.models.components.ParcelExtra;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsurance;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;\nimport com.goshippo.shippo_sdk.models.components.ParcelTemplateDHLeCommerceEnum;\nimport com.goshippo.shippo_sdk.models.components.ParcelTemplateDPDUKEnum;\nimport com.goshippo.shippo_sdk.models.components.ParcelTemplateEnumSet;\nimport com.goshippo.shippo_sdk.models.components.ParcelTemplateUSPSEnum;\nimport com.goshippo.shippo_sdk.models.components.Parcels;\nimport com.goshippo.shippo_sdk.models.components.PaymentMethod;\nimport com.goshippo.shippo_sdk.models.components.PoNumber;\nimport com.goshippo.shippo_sdk.models.components.RmaNumber;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;\nimport com.goshippo.shippo_sdk.models.components.ShipmentExtra;\nimport com.goshippo.shippo_sdk.models.components.UPSReferenceFields;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.AddShipmentsToBatchResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n AddShipmentsToBatchResponse res = sdk.batches().addShipments()\n .batchId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .requestBody(List.of(\n BatchShipmentCreateRequest.builder()\n .shipment(ShipmentCreateRequest.builder()\n .addressFrom(AddressFrom.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .addressTo(AddressTo.of(\"d799c2679e644279b59fe661ac8fa489\"))\n .parcels(List.of(\n Parcels.of(\"\"),\n Parcels.of(\"\"),\n Parcels.of(ParcelCreateFromTemplateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .template(ParcelTemplateEnumSet.of(ParcelTemplateUSPSEnum.USPS_SMALL_FLAT_RATE_ENVELOPE))\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build())))\n .extra(ShipmentExtra.builder()\n .accountsReceivableCustomerAccount(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .appropriationNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .billOfLadingNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .codNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .customerReference(CustomerReference.builder()\n .refSort(1L)\n .build())\n .dealerOrderNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .deptNumber(DepartmentNumber.builder()\n .refSort(3L)\n .build())\n .fdaProductCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .insurance(Insurance.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .build())\n .invoiceNumber(InvoiceNumber.builder()\n .refSort(2L)\n .build())\n .manifestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .modelNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .partNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .poNumber(PoNumber.builder()\n .refSort(2L)\n .build())\n .productionCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .purchaseRequestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .rmaNumber(RmaNumber.builder()\n .refSort(1L)\n .build())\n .salespersonNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .serialNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .storeNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .transactionReferenceNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .shipmentDate(\"2021-03-22T12:00:00Z\")\n .addressReturn(AddressReturn.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(\"adcfdddf8ec64b84ad22772bce3ea37a\"))\n .carrierAccounts(List.of(\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"))\n .build())\n .carrierAccount(\"a4391cd4ab974f478f55dc08b5c8e3b3\")\n .metadata(\"SHIPMENT #1\")\n .servicelevelToken(\"fedex_ground\")\n .build(),\n BatchShipmentCreateRequest.builder()\n .shipment(ShipmentCreateRequest.builder()\n .addressFrom(AddressFrom.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .addressTo(AddressTo.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .parcels(List.of(\n Parcels.of(ParcelCreateFromTemplateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .template(ParcelTemplateEnumSet.of(ParcelTemplateDPDUKEnum.DPDUK_EXPRESS_PAK))\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build()),\n Parcels.of(ParcelCreateFromTemplateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .template(ParcelTemplateEnumSet.of(ParcelTemplateDHLeCommerceEnum.DH_LE_C_IRREGULAR))\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build())))\n .extra(ShipmentExtra.builder()\n .accountsReceivableCustomerAccount(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .appropriationNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .billOfLadingNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .codNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .customerReference(CustomerReference.builder()\n .refSort(1L)\n .build())\n .dealerOrderNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .deptNumber(DepartmentNumber.builder()\n .refSort(3L)\n .build())\n .fdaProductCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .insurance(Insurance.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .build())\n .invoiceNumber(InvoiceNumber.builder()\n .refSort(2L)\n .build())\n .manifestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .modelNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .partNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .poNumber(PoNumber.builder()\n .refSort(2L)\n .build())\n .productionCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .purchaseRequestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .rmaNumber(RmaNumber.builder()\n .refSort(1L)\n .build())\n .salespersonNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .serialNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .storeNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .transactionReferenceNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .shipmentDate(\"2021-03-22T12:00:00Z\")\n .addressReturn(AddressReturn.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(CustomsDeclarationCreateRequest.builder()\n .certify(true)\n .certifySigner(\"Shawn Ippotle\")\n .contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)\n .items(List.of(\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build()))\n .nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)\n .b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)\n .contentsExplanation(\"T-Shirt purchase\")\n .dutiesPayor(DutiesPayor.builder()\n .account(\"2323434543\")\n .type(CustomsDeclarationCreateRequestType.THIRD_PARTY)\n .address(CustomsDeclarationCreateRequestAddress.builder()\n .name(\"Patrick Kavanagh\")\n .zip(\"80331\")\n .country(\"DE\")\n .build())\n .build())\n .exporterIdentification(CustomsExporterIdentification.builder()\n .eoriNumber(\"PL123456790ABCDE\")\n .taxId(CustomsTaxIdentification.builder()\n .number(\"123456789\")\n .type(CustomsTaxIdentificationType.EIN)\n .build())\n .build())\n .invoice(\"#123123\")\n .metadata(\"Order ID #123123\")\n .addressImporter(AddressImporter.builder()\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"Blumenstraße\")\n .street3(\"\")\n .streetNo(\"22\")\n .city(\"München\")\n .state(\"CA\")\n .zip(\"80331\")\n .country(\"DE\")\n .phone(\"80331\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .build())\n .eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)\n .incoterm(CustomsDeclarationIncotermEnum.DDP)\n .test(true)\n .build()))\n .carrierAccounts(List.of(\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"))\n .build())\n .carrierAccount(\"a4391cd4ab974f478f55dc08b5c8e3b3\")\n .metadata(\"SHIPMENT #1\")\n .servicelevelToken(\"fedex_ground\")\n .build(),\n BatchShipmentCreateRequest.builder()\n .shipment(ShipmentCreateRequest.builder()\n .addressFrom(AddressFrom.of(\"d799c2679e644279b59fe661ac8fa488\"))\n .addressTo(AddressTo.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .parcels(List.of(\n Parcels.of(\"\")))\n .extra(ShipmentExtra.builder()\n .accountsReceivableCustomerAccount(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .appropriationNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .billOfLadingNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .codNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .customerReference(CustomerReference.builder()\n .refSort(1L)\n .build())\n .dealerOrderNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .deptNumber(DepartmentNumber.builder()\n .refSort(3L)\n .build())\n .fdaProductCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .insurance(Insurance.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .build())\n .invoiceNumber(InvoiceNumber.builder()\n .refSort(2L)\n .build())\n .manifestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .modelNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .partNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .poNumber(PoNumber.builder()\n .refSort(2L)\n .build())\n .productionCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .purchaseRequestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .rmaNumber(RmaNumber.builder()\n .refSort(1L)\n .build())\n .salespersonNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .serialNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .storeNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .transactionReferenceNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .shipmentDate(\"2021-03-22T12:00:00Z\")\n .addressReturn(AddressReturn.of(\"d799c2679e644279b59fe661ac8fa488\"))\n .customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(\"adcfdddf8ec64b84ad22772bce3ea37a\"))\n .carrierAccounts(List.of(\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"))\n .build())\n .carrierAccount(\"a4391cd4ab974f478f55dc08b5c8e3b3\")\n .metadata(\"SHIPMENT #1\")\n .servicelevelToken(\"fedex_ground\")\n .build()))\n .call();\n\n if (res.batch().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "addShipments" } }, "/batches/{BatchId}/purchase": { "post": { "description": "Purchases an existing batch with a status of `VALID`. \nOnce you send a POST request to the purchase endpoint the batch status will change to `PURCHASING`. \nWhen all the shipments are purchased, the status will change to `PURCHASED` and you will receive a \n`batch_purchased` webhook indicating that the batch has been purchased", "operationId": "PurchaseBatch", "parameters": [ { "description": "Object ID of the batch", "in": "path", "name": "BatchId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "202": { "$ref": "#/components/responses/batchResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Purchase a batch", "tags": [ "Batches" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X POST https://api.goshippo.com/batches//purchase \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.batches.purchase(batch_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.batches.purchase(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Batches.PurchaseAsync(\n batchId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->batches->purchase(\n batchId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->batch !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.PurchaseBatchResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n PurchaseBatchResponse res = sdk.batches().purchase()\n .batchId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.batch().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "purchase" } }, "/batches/{BatchId}/remove_shipments": { "post": { "description": "Removes shipments from an existing batch shipment.", "operationId": "RemoveShipmentsFromBatch", "parameters": [ { "description": "Object ID of the batch", "in": "path", "name": "BatchId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "items": { "type": "string" }, "type": "array" } } }, "description": "Array of shipments object ids to remove from the batch" }, "responses": { "200": { "$ref": "#/components/responses/batchResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Remove shipments from a batch", "tags": [ "Batches" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X POST https://api.goshippo.com/batches//remove_shipments \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '[\n \"aa7dea463a5a48b0b8fb21f90e72d779\",\n \"f11b46440c144ce3b97fb5ddf02b8c71\",\n \"5400f9078f764b1bbb121bcd08de127f\",\n \"2ab2b452392545908d2cef8861a39c35\"\n ]'" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.batches.remove_shipments(request_body=[\n '',\n '',\n '',\n], batch_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.batches.removeShipments([\n \"\",\n \"\",\n \"\",\n ], \"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Batches.RemoveShipmentsAsync(\n batchId: \"\",\n requestBody: new List() {\n \"\",\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->batches->removeShipments(\n batchId: '',\n requestBody: [\n '',\n ],\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->batch !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.RemoveShipmentsFromBatchResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n RemoveShipmentsFromBatchResponse res = sdk.batches().removeShipments()\n .batchId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .requestBody(List.of(\n \"\",\n \"\",\n \"\"))\n .call();\n\n if (res.batch().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "removeShipments" } }, "/carrier_accounts": { "get": { "description": "Returns a list of all carrier accounts connected to your Shippo account. These carrier accounts include both Shippo carrier accounts and your own carrier accounts that you have connected to your Shippo account.\n\nAdditionally, you can get information about the service levels associated with each carrier account by passing in the `?service_levels=true` query parameter.
\nUsing it appends the property `service_levels` to each carrier account.
\nBy default, if the query parameter is omitted, the `service_levels` property will not be included in the response.", "operationId": "ListCarrierAccounts", "parameters": [ { "description": "Appends the property `service_levels` to each returned carrier account", "in": "query", "name": "service_levels", "required": false, "schema": { "type": "boolean" } }, { "description": "Filter the response by the specified carrier", "in": "query", "name": "carrier", "required": false, "schema": { "$ref": "#/components/schemas/CarriersEnum" } }, { "description": "Filter the response by the specified carrier account Id", "in": "query", "name": "account_id", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageDefault5QueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/carrierAccountPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all carrier accounts", "tags": [ "Carrier Accounts" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/carrier_accounts?service_levels=true \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.list(request=operations.ListCarrierAccountsRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListCarrierAccountsRequest();\n\n$response = $sdk->carrierAccounts->list(\n request: $request\n);\n\nif ($response->carrierAccountPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListCarrierAccountsRequest req = new ListCarrierAccountsRequest() {};\n\nvar res = await sdk.CarrierAccounts.ListAsync(req);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListCarrierAccountsRequest;\nimport com.goshippo.shippo_sdk.models.operations.ListCarrierAccountsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListCarrierAccountsRequest req = ListCarrierAccountsRequest.builder()\n .build();\n\n ListCarrierAccountsResponse res = sdk.carrierAccounts().list()\n .request(req)\n .call();\n\n if (res.carrierAccountPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new carrier account or connects an existing carrier account to the Shippo account.", "operationId": "CreateCarrierAccount", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ConnectExistingOwnAccountRequest" } } }, "description": "Examples.", "x-examples": { "application/json": { "fedex-existing-account-example": { "summary": "Connect an existing Fedex account to Shippo", "value": { "account_id": 321123, "carrier": "fedex", "metadata": "FedEx Account", "parameters": { "first_name": "Hippo", "from_address_city": "San Francisco", "from_address_country_iso2": "US", "from_address_st": "250 Union St", "from_address_state": "CA", "from_address_zip": 94133, "last_name": "Hippovich", "meter": 118599345, "phone_number": 1112223333, "smartpost_id": 5902 }, "test": false } }, "ups-existing-account-example": { "summary": "Connect an existing UPS account to Shippo", "value": { "account_id": 123456, "active": true, "carrier": "ups", "metadata": "UPS Account", "parameters": { "account_number": "94567e", "aia_country_iso2": "US", "billing_address_city": "San Francisco", "billing_address_country_iso2": "US", "billing_address_state": "CA", "billing_address_street1": "731 Market St", "billing_address_street2": "STE 200", "billing_address_zip": 94103, "collec_country_iso2": "US", "collec_zip": 94103, "company": "Shippo", "currency_code": "USD", "email": "hippo@shippo.com", "full_name": "Shippo Meister", "has_invoice": false, "invoice_controlid": 1234, "invoice_date": 20210529, "invoice_number": 1112234, "invoice_value": 11.23, "phone": 1112223333, "title": "Manager", "ups_agreements": true }, "test": false } }, "ups-new-account-example": { "summary": "Create a new UPS account", "value": { "account_id": 123456, "active": true, "carrier": "ups", "metadata": "UPS Account", "parameters": { "billing_address_city": "San Francisco", "billing_address_country_iso2": "US", "billing_address_state": "CA", "billing_address_street1": "731 Market St", "billing_address_street2": "STE 200", "billing_address_zip": 94103, "company": "Shippo", "email": "hippo@shippo.com", "full_name": "Shippo Meister", "phone": 1112223333, "pickup_address_city": "San Francisco", "pickup_address_country_iso2": "US", "pickup_address_same_as_billing_address": false, "pickup_address_state": "CA", "pickup_address_street1": "731 Market St", "pickup_address_street2": "STE 200", "pickup_address_zip": 94103, "ups_agreements": true }, "test": false } } } } }, "responses": { "201": { "$ref": "#/components/responses/carrierAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new carrier account", "tags": [ "Carrier Accounts" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl --location --request POST 'https://api.goshippo.com/carrier_accounts/' \\\n--header 'Authorization: ShippoToken {{token}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"account_id\": \"string\",\n \"active\": true,\n \"carrier\": \"ups\",\n \"metadata\": \"UPS Account\",\n \"parameters\": {\n \"billing_address_city\": \"San Francisco\",\n \"billing_address_country_iso2\": \"US\",\n \"billing_address_state\": \"CA\",\n \"billing_address_street1\": \"731 Market St\",\n \"billing_address_street2\": \"STE 200\",\n \"billing_address_zip\": \"94103\",\n \"company\": \"Shippo\",\n \"email\": \"hippo@shippo.com\",\n \"full_name\": \"Thorn Hall\",\n \"phone\": \"1112223333\",\n \"pickup_address_city\": \"San Francisco\",\n \"pickup_address_country_iso2\": \"US\",\n \"pickup_address_same_as_billing_address\": false,\n \"pickup_address_state\": \"CA\",\n \"pickup_address_street1\": \"731 Market St\",\n \"pickup_address_street2\": \"STE 200\",\n \"pickup_address_zip\": \"94103\",\n \"ups_agreements\": true\n },\n \"test\": false\n}'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.create(request=components.ConnectExistingOwnAccountRequest(\n account_id='321123',\n carrier='fedex',\n metadata='FEDEX Account',\n parameters=components.FedExConnectExistingOwnAccountParameters(\n first_name='Loyal',\n last_name='Collier',\n phone_number='(890) 307-8579',\n from_address_st='',\n from_address_city='',\n from_address_state='',\n from_address_zip='',\n from_address_country_iso2='',\n use_multi_factor_registration=True,\n verification_option='SMS',\n ),\n test=False,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.create({\n accountId: \"321123\",\n carrier: \"fedex\",\n metadata: \"FEDEX Account\",\n parameters: {\n firstName: \"Loyal\",\n lastName: \"Collier\",\n phoneNumber: \"(890) 307-8579\",\n fromAddressSt: \"\",\n fromAddressCity: \"\",\n fromAddressState: \"\",\n fromAddressZip: \"\",\n fromAddressCountryIso2: \"\",\n useMultiFactorRegistration: true,\n verificationOption: \"SMS\",\n },\n test: false,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$connectExistingOwnAccountRequest = new Components\\ConnectExistingOwnAccountRequest(\n accountId: '321123',\n carrier: 'fedex',\n metadata: 'FEDEX Account',\n parameters: new Components\\FedExConnectExistingOwnAccountParameters(\n firstName: 'Loyal',\n lastName: 'Collier',\n phoneNumber: '(890) 307-8579',\n fromAddressSt: '',\n fromAddressCity: '',\n fromAddressState: '',\n fromAddressZip: '',\n fromAddressCountryIso2: '',\n useMultiFactorRegistration: true,\n verificationOption: 'SMS',\n ),\n test: false,\n);\n\n$response = $sdk->carrierAccounts->create(\n connectExistingOwnAccountRequest: $connectExistingOwnAccountRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierAccount !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierAccounts.CreateAsync(\n connectExistingOwnAccountRequest: new ConnectExistingOwnAccountRequest() {\n AccountId = \"321123\",\n Carrier = \"fedex\",\n Metadata = \"FEDEX Account\",\n Parameters = ConnectExistingOwnAccountRequestParameters.CreateFedExConnectExistingOwnAccountParameters(\n new FedExConnectExistingOwnAccountParameters() {\n FirstName = \"Loyal\",\n LastName = \"Collier\",\n PhoneNumber = \"(890) 307-8579\",\n FromAddressSt = \"\",\n FromAddressCity = \"\",\n FromAddressState = \"\",\n FromAddressZip = \"\",\n FromAddressCountryIso2 = \"\",\n UseMultiFactorRegistration = true,\n VerificationOption = \"SMS\",\n }\n ),\n Test = false,\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.ConnectExistingOwnAccountRequest;\nimport com.goshippo.shippo_sdk.models.components.ConnectExistingOwnAccountRequestParameters;\nimport com.goshippo.shippo_sdk.models.components.FedExConnectExistingOwnAccountParameters;\nimport com.goshippo.shippo_sdk.models.operations.CreateCarrierAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateCarrierAccountResponse res = sdk.carrierAccounts().create()\n .shippoApiVersion(\"2018-02-08\")\n .connectExistingOwnAccountRequest(ConnectExistingOwnAccountRequest.builder()\n .accountId(\"321123\")\n .carrier(\"fedex\")\n .parameters(ConnectExistingOwnAccountRequestParameters.of(FedExConnectExistingOwnAccountParameters.builder()\n .firstName(\"Loyal\")\n .lastName(\"Collier\")\n .phoneNumber(\"(890) 307-8579\")\n .fromAddressSt(\"\")\n .fromAddressCity(\"\")\n .fromAddressState(\"\")\n .fromAddressZip(\"\")\n .fromAddressCountryIso2(\"\")\n .useMultiFactorRegistration(true)\n .verificationOption(\"SMS\")\n .build()))\n .metadata(\"FEDEX Account\")\n .test(false)\n .build())\n .call();\n\n if (res.carrierAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/carrier_accounts/{CarrierAccountId}": { "get": { "description": "Returns an existing carrier account using an object ID.", "operationId": "GetCarrierAccount", "parameters": [ { "description": "Object ID of the carrier account", "in": "path", "name": "CarrierAccountId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/carrierAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a carrier account", "tags": [ "Carrier Accounts" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/carrier_accounts/b741b99f95e841639b54272834bc478c \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.get(carrier_account_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->carrierAccounts->get(\n carrierAccountId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierAccount !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierAccounts.GetAsync(\n carrierAccountId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetCarrierAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetCarrierAccountResponse res = sdk.carrierAccounts().get()\n .carrierAccountId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.carrierAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "put": { "description": "Updates an existing carrier account object. The account_id and carrier can't be updated. This is because they form the unique identifier together.", "operationId": "UpdateCarrierAccount", "parameters": [ { "description": "Object ID of the carrier account", "in": "path", "name": "CarrierAccountId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAccountUpdateRequest" } } }, "description": "Examples.", "x-examples": { "application/json": { "update-carrier-account": { "summary": "Update a carrier account", "value": { "account_id": 123356, "active": true, "carrier": "ups", "parameters": {} } } } } }, "responses": { "200": { "$ref": "#/components/responses/carrierAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Update a carrier account", "tags": [ "Carrier Accounts" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/carrier_accounts/b741b99f95e841639b54272834bc478c/ \\\n-X PUT \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d parameters='{\n \"meter\": \"123987\"\n}'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.update(carrier_account_id='', carrier_account_base=components.CarrierAccountBase(\n account_id='****',\n carrier='usps',\n parameters=components.UPSConnectExistingOwnAccountParameters(\n account_number='94567e',\n aia_country_iso2='US',\n billing_address_city='San Francisco',\n billing_address_country_iso2='US',\n billing_address_state='CA',\n billing_address_street1='731 Market St',\n billing_address_street2='STE 200',\n billing_address_zip='94103',\n collec_country_iso2='US',\n collec_zip='94103',\n company='Shippo',\n currency_code='USD',\n email='hippo@shippo.com',\n full_name='Shippo Meister',\n has_invoice=False,\n invoice_controlid='1234',\n invoice_date='20210529',\n invoice_number='1112234',\n invoice_value='11.23',\n phone='1112223333',\n title='Manager',\n ups_agreements=True,\n ),\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.update(\"\", {\n accountId: \"****\",\n carrier: \"usps\",\n parameters: {\n accountNumber: \"94567e\",\n aiaCountryIso2: \"US\",\n billingAddressCity: \"San Francisco\",\n billingAddressCountryIso2: \"US\",\n billingAddressState: \"CA\",\n billingAddressStreet1: \"731 Market St\",\n billingAddressStreet2: \"STE 200\",\n billingAddressZip: \"94103\",\n collecCountryIso2: \"US\",\n collecZip: \"94103\",\n company: \"Shippo\",\n currencyCode: \"USD\",\n email: \"hippo@shippo.com\",\n fullName: \"Shippo Meister\",\n hasInvoice: false,\n invoiceControlid: \"1234\",\n invoiceDate: \"20210529\",\n invoiceNumber: \"1112234\",\n invoiceValue: \"11.23\",\n phone: \"1112223333\",\n title: \"Manager\",\n upsAgreements: true,\n },\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$carrierAccountBase = new Components\\CarrierAccountBase(\n accountId: '****',\n carrier: 'usps',\n parameters: new Components\\UPSConnectExistingOwnAccountParameters(\n accountNumber: '94567e',\n aiaCountryIso2: 'US',\n billingAddressCity: 'San Francisco',\n billingAddressCountryIso2: 'US',\n billingAddressState: 'CA',\n billingAddressStreet1: '731 Market St',\n billingAddressStreet2: 'STE 200',\n billingAddressZip: '94103',\n collecCountryIso2: 'US',\n collecZip: '94103',\n company: 'Shippo',\n currencyCode: 'USD',\n email: 'hippo@shippo.com',\n fullName: 'Shippo Meister',\n hasInvoice: false,\n invoiceControlid: '1234',\n invoiceDate: '20210529',\n invoiceNumber: '1112234',\n invoiceValue: '11.23',\n phone: '1112223333',\n title: 'Manager',\n upsAgreements: false,\n ),\n);\n\n$response = $sdk->carrierAccounts->update(\n carrierAccountId: '',\n shippoApiVersion: '2018-02-08',\n carrierAccountBase: $carrierAccountBase\n\n);\n\nif ($response->carrierAccount !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierAccounts.UpdateAsync(\n carrierAccountId: \"\",\n shippoApiVersion: \"2018-02-08\",\n carrierAccountBase: new CarrierAccountBase() {\n AccountId = \"****\",\n Carrier = \"usps\",\n Parameters = CarrierAccountBaseParameters.CreateUPSConnectExistingOwnAccountParameters(\n new UPSConnectExistingOwnAccountParameters() {\n AccountNumber = \"94567e\",\n AiaCountryIso2 = \"US\",\n BillingAddressCity = \"San Francisco\",\n BillingAddressCountryIso2 = \"US\",\n BillingAddressState = \"CA\",\n BillingAddressStreet1 = \"731 Market St\",\n BillingAddressStreet2 = \"STE 200\",\n BillingAddressZip = \"94103\",\n CollecCountryIso2 = \"US\",\n CollecZip = \"94103\",\n Company = \"Shippo\",\n CurrencyCode = \"USD\",\n Email = \"hippo@shippo.com\",\n FullName = \"Shippo Meister\",\n HasInvoice = false,\n InvoiceControlid = \"1234\",\n InvoiceDate = \"20210529\",\n InvoiceNumber = \"1112234\",\n InvoiceValue = \"11.23\",\n Phone = \"1112223333\",\n Title = \"Manager\",\n UpsAgreements = false,\n }\n ),\n }\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.CarrierAccountBase;\nimport com.goshippo.shippo_sdk.models.components.CarrierAccountBaseParameters;\nimport com.goshippo.shippo_sdk.models.components.UPSConnectExistingOwnAccountParameters;\nimport com.goshippo.shippo_sdk.models.operations.UpdateCarrierAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateCarrierAccountResponse res = sdk.carrierAccounts().update()\n .carrierAccountId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .carrierAccountBase(CarrierAccountBase.builder()\n .accountId(\"****\")\n .carrier(\"usps\")\n .parameters(CarrierAccountBaseParameters.of(UPSConnectExistingOwnAccountParameters.builder()\n .accountNumber(\"94567e\")\n .billingAddressCity(\"San Francisco\")\n .billingAddressCountryIso2(\"US\")\n .billingAddressState(\"CA\")\n .billingAddressStreet1(\"731 Market St\")\n .billingAddressZip(\"94103\")\n .collecCountryIso2(\"US\")\n .collecZip(\"94103\")\n .company(\"Shippo\")\n .email(\"hippo@shippo.com\")\n .fullName(\"Shippo Meister\")\n .hasInvoice(false)\n .phone(\"1112223333\")\n .title(\"Manager\")\n .upsAgreements(true)\n .aiaCountryIso2(\"US\")\n .billingAddressStreet2(\"STE 200\")\n .currencyCode(\"USD\")\n .invoiceControlid(\"1234\")\n .invoiceDate(\"20210529\")\n .invoiceNumber(\"1112234\")\n .invoiceValue(\"11.23\")\n .build()))\n .build())\n .call();\n\n if (res.carrierAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/carrier_accounts/{CarrierAccountObjectId}/signin/initiate": { "get": { "description": "Used by client applications to setup or reconnect an existing carrier account with carriers that support OAuth 2.0", "summary": "Connect an existing carrier account using OAuth 2.0", "operationId": "InitiateOauth2Signin", "parameters": [ { "description": "The carrier account ID (UUID) to start a signin process.", "in": "path", "name": "CarrierAccountObjectId", "required": true, "schema": { "type": "string" } }, { "description": "Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.", "in": "query", "name": "redirect_uri", "required": true, "schema": { "type": "string", "format": "uri" } }, { "description": "A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application checks that the same value is returned after the user authorizes Shippo.", "in": "query", "name": "state", "required": false, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "302": { "description": "Redirects the browser to the carrier login page, with the needed parameters", "headers": { "Location": { "description": "Carrier login page URI, with the needed parameters set as query string", "schema": { "type": "string", "format": "uri" }, "example": "https://www.ups.com/lasso/signin?client_id=testClientID&redirect_uri=https://client.example.com/cb&response_type=code&scope=read&type=ups_com_api" } } }, "400": { "description": "Invalid parameters provided by the user", "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "example": "Missing required parameter" }, "detail": { "type": "string", "example": "redirect_uri" } } } } } }, "401": { "description": "Invalid ShippoToken or unsupported carrier account provided by the user", "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "example": "Unsupported OAuth Carrier Account" }, "detail": { "type": "string", "example": "The carrier account 3c49f998b1234a2097ea0911a7e95bea does not support OAuth authorization" } } } } } }, "404": { "description": "Invalid carrier account provided by the user", "content": { "application/json": { "schema": { "properties": { "title": { "type": "string", "example": "Carrier Account not found" }, "detail": { "type": "string", "example": "Carrier Account not found for object_id: 3c49f998b1234a2097ea0911a7e95bea" } } } } } } }, "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl \"https://api.goshippo.com/carrier_accounts/2ccf5af209bb484cb20190d9cadbb61c/signin/initiate?redirect_uri=https://client.example.com/cb&state=SplxlOBeZQQYbYS6WxSbIA\" \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.initiate_oauth2_signin(carrier_account_object_id='', redirect_uri='https://enlightened-mortise.com/')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.initiateOauth2Signin(\"\", \"https://enlightened-mortise.com/\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nInitiateOauth2SigninRequest req = new InitiateOauth2SigninRequest() {\n CarrierAccountObjectId = \"\",\n RedirectUri = \"https://enlightened-mortise.com/\",\n};\n\nvar res = await sdk.CarrierAccounts.InitiateOauth2SigninAsync(req);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\InitiateOauth2SigninRequest(\n carrierAccountObjectId: '',\n redirectUri: 'https://enlightened-mortise.com/',\n);\n\n$response = $sdk->carrierAccounts->initiateOauth2Signin(\n request: $request\n);\n\nif ($response->statusCode === 200) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseBody;\nimport com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninCarrierAccountsResponseResponseBody;\nimport com.goshippo.shippo_sdk.models.errors.InitiateOauth2SigninResponseBody;\nimport com.goshippo.shippo_sdk.models.operations.InitiateOauth2SigninResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws InitiateOauth2SigninResponseBody, InitiateOauth2SigninCarrierAccountsResponseResponseBody, InitiateOauth2SigninCarrierAccountsResponseBody, Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n InitiateOauth2SigninResponse res = sdk.carrierAccounts().initiateOauth2Signin()\n .carrierAccountObjectId(\"\")\n .redirectUri(\"https://enlightened-mortise.com/\")\n .state(\"Florida\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n // handle response\n }\n}" } ], "tags": [ "Carrier Accounts" ] } }, "/carrier_accounts/register/new": { "post": { "description": "Adds a Shippo carrier account", "operationId": "RegisterCarrierAccount", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/CarrierAccountCanadaPostCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountChronopostCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountColissimoCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountCorreosCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountDeutschePostCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountDHLExpressCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountDpdDeCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountDPDUKCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountFedExCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountHermesUKCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountMondialRelayCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountPosteItalianeCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountUPSCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountUSPSCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountRoyalMailCreateRequest" }, { "$ref": "#/components/schemas/CarrierAccountRoyalMailSfCreateRequest" } ], "discriminator": { "propertyName": "carrier", "mapping": { "canada_post": "#/components/schemas/CarrierAccountCanadaPostCreateRequest", "chronopost": "#/components/schemas/CarrierAccountChronopostCreateRequest", "colissimo": "#/components/schemas/CarrierAccountColissimoCreateRequest", "correos": "#/components/schemas/CarrierAccountCorreosCreateRequest", "deutsche_post": "#/components/schemas/CarrierAccountDeutschePostCreateRequest", "dhl_express": "#/components/schemas/CarrierAccountDHLExpressCreateRequest", "dpd_de": "#/components/schemas/CarrierAccountDpdDeCreateRequest", "dpd_uk": "#/components/schemas/CarrierAccountDPDUKCreateRequest", "fedex": "#/components/schemas/CarrierAccountFedExCreateRequest", "hermes_uk": "#/components/schemas/CarrierAccountHermesUKCreateRequest", "mondial_relay": "#/components/schemas/CarrierAccountMondialRelayCreateRequest", "poste_italiane": "#/components/schemas/CarrierAccountPosteItalianeCreateRequest", "ups": "#/components/schemas/CarrierAccountUPSCreateRequest", "usps": "#/components/schemas/CarrierAccountUSPSCreateRequest", "royal_mail": "#/components/schemas/CarrierAccountRoyalMailCreateRequest", "royal_mail_sf": "#/components/schemas/CarrierAccountRoyalMailSfCreateRequest" } } } } }, "description": "The body of the request." }, "responses": { "201": { "$ref": "#/components/responses/carrierAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Add a Shippo carrier account", "tags": [ "Carrier Accounts" ], "x-codeSamples": [ { "label": "CLI", "lang": "cURL", "source": "curl --location --request POST '/carrier_accounts/register/new' \\\n--header 'Authorization: ShippoToken {{token}}' \\\n--header 'Content-Type: application/json' \\\n--data-raw '{\n \"carrier\": \"canada_post\",\n \"parameters\": {\n \"company\": \"Shippo\",\n \"full_name\": \"Shippo Meister\",\n \"email\": \"hippo@shippo.com\",\n \"phone\": \"1112221122\",\n \"canada_post_terms\": true\n }\n}'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.register(request=components.CarrierAccountCorreosCreateRequest(\n parameters=components.CarrierAccountCorreosCreateRequestParameters(),\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.register({\n parameters: {},\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierAccounts.RegisterAsync(\n requestBody: RegisterCarrierAccountRequestBody.CreateCarrierAccountCorreosCreateRequest(\n new CarrierAccountCorreosCreateRequest() {\n Parameters = new CarrierAccountCorreosCreateRequestParameters() {},\n }\n ),\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->carrierAccounts->register(\n requestBody: new Components\\CarrierAccountCorreosCreateRequest(\n parameters: new Components\\CarrierAccountCorreosCreateRequestParameters(),\n ),\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierAccount !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.CarrierAccountCorreosCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CarrierAccountCorreosCreateRequestParameters;\nimport com.goshippo.shippo_sdk.models.operations.RegisterCarrierAccountRequestBody;\nimport com.goshippo.shippo_sdk.models.operations.RegisterCarrierAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n RegisterCarrierAccountResponse res = sdk.carrierAccounts().register()\n .shippoApiVersion(\"2018-02-08\")\n .requestBody(RegisterCarrierAccountRequestBody.of(CarrierAccountCorreosCreateRequest.builder()\n .parameters(CarrierAccountCorreosCreateRequestParameters.builder()\n .build())\n .build()))\n .call();\n\n if (res.carrierAccount().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "register" } }, "/carrier_accounts/reg-status": { "get": { "description": "Returns the registration status for the given account for the given carrier", "operationId": "GetCarrierRegistrationStatus", "parameters": [ { "in": "query", "description": "filter by specific carrier", "name": "carrier", "required": true, "schema": { "type": "string", "enum": [ "ups", "usps", "canada_post" ] } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/carrierAccountRegistrationStatusResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Get Carrier Registration status", "tags": [ "Carrier Accounts" ], "x-speakeasy-name-override": "getRegistrationStatus", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_accounts.get_registration_status(carrier=operations.Carrier.USPS)\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierAccounts.getRegistrationStatus(\"usps\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierAccounts.GetRegistrationStatusAsync(\n carrier: Carrier.Usps,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->carrierAccounts->getRegistrationStatus(\n carrier: Operations\\Carrier::Usps,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierAccountRegistrationStatus !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.Carrier;\nimport com.goshippo.shippo_sdk.models.operations.GetCarrierRegistrationStatusResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetCarrierRegistrationStatusResponse res = sdk.carrierAccounts().getRegistrationStatus()\n .carrier(Carrier.USPS)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.carrierAccountRegistrationStatus().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/customs/declarations": { "get": { "description": "Returns a list of all customs declaration objects", "operationId": "ListCustomsDeclarations", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageDefault5QueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/customsDeclarationPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all customs declarations", "tags": [ "Customs Declarations" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/declarations/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_declarations.list()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsDeclarations.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->customsDeclarations->list(\n page: 1,\n results: 5,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsDeclarationPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsDeclarations.ListAsync(\n page: 1,\n results: 5,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListCustomsDeclarationsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListCustomsDeclarationsResponse res = sdk.customsDeclarations().list()\n .page(1L)\n .results(5L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.customsDeclarationPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new customs declaration object", "operationId": "CreateCustomsDeclaration", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclarationCreateRequest" } } }, "description": "CustomsDeclaration details." }, "responses": { "201": { "$ref": "#/components/responses/customsDeclarationResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new customs declaration", "tags": [ "Customs Declarations" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/declarations/ \\\n-H \"Authorization: ShippoToken \" \\\n-H \"Content-Type: application/json\" \\\n-d '{ \n \"contents_type\": \"MERCHANDISE\",\n \"non_delivery_option\": \"RETURN\",\n \"certify\": true,\n \"certify_signer\": \"Simon Kreuz\",\n \"incoterm\": \"DDU\",\n \"items\": [{\n \"description\": \"T-shirt\",\n \"quantity\": 20,\n \"net_weight\": \"5\",\n \"mass_unit\": \"lb\",\n \"value_amount\": \"200\",\n \"value_currency\": \"USD\",\n \"tariff_number\": \"\",\n \"origin_country\": \"US\"\n }]\n}'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_declarations.create(request=components.CustomsDeclarationCreateRequest(\n b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,\n certify=True,\n certify_signer='Shawn Ippotle',\n contents_explanation='T-Shirt purchase',\n duties_payor=components.DutiesPayor(\n account='2323434543',\n type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,\n address=components.CustomsDeclarationCreateRequestAddress(\n name='Patrick Kavanagh',\n zip='80331',\n country='DE',\n ),\n ),\n exporter_identification=components.CustomsExporterIdentification(\n eori_number='PL123456790ABCDE',\n tax_id=components.CustomsTaxIdentification(\n number='123456789',\n type=components.CustomsTaxIdentificationType.EIN,\n ),\n ),\n invoice='#123123',\n metadata='Order ID #123123',\n address_importer=components.AddressImporter(\n name='Shwan Ippotle',\n company='Shippo',\n street1='Blumenstraße',\n street3='',\n street_no='22',\n city='München',\n state='CA',\n zip='80331',\n country='DE',\n phone='80331',\n email='shippotle@shippo.com',\n is_residential=True,\n ),\n contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,\n eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,\n incoterm=components.CustomsDeclarationIncotermEnum.DDP,\n items=[\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n ],\n non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,\n test=True,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsDeclarations.create({\n b13aFilingOption: \"FILED_ELECTRONICALLY\",\n certify: true,\n certifySigner: \"Shawn Ippotle\",\n contentsExplanation: \"T-Shirt purchase\",\n dutiesPayor: {\n account: \"2323434543\",\n type: \"THIRD_PARTY\",\n address: {\n name: \"Patrick Kavanagh\",\n zip: \"80331\",\n country: \"DE\",\n },\n },\n exporterIdentification: {\n eoriNumber: \"PL123456790ABCDE\",\n taxId: {\n number: \"123456789\",\n type: \"EIN\",\n },\n },\n invoice: \"#123123\",\n metadata: \"Order ID #123123\",\n addressImporter: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"Blumenstraße\",\n street3: \"\",\n streetNo: \"22\",\n city: \"München\",\n state: \"CA\",\n zip: \"80331\",\n country: \"DE\",\n phone: \"80331\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n },\n contentsType: \"MERCHANDISE\",\n eelPfc: \"NOEEI_30_37_a\",\n incoterm: \"DDP\",\n items: [\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n ],\n nonDeliveryOption: \"RETURN\",\n test: true,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$customsDeclarationCreateRequest = new Components\\CustomsDeclarationCreateRequest(\n b13aFilingOption: Components\\CustomsDeclarationB13AFilingOptionEnum::FiledElectronically,\n certify: true,\n certifySigner: 'Shawn Ippotle',\n contentsExplanation: 'T-Shirt purchase',\n dutiesPayor: new Components\\DutiesPayor(\n account: '2323434543',\n type: Components\\CustomsDeclarationCreateRequestType::ThirdParty,\n address: new Components\\CustomsDeclarationCreateRequestAddress(\n name: 'Patrick Kavanagh',\n zip: '80331',\n country: 'DE',\n ),\n ),\n exporterIdentification: new Components\\CustomsExporterIdentification(\n eoriNumber: 'PL123456790ABCDE',\n taxId: new Components\\CustomsTaxIdentification(\n number: '123456789',\n type: Components\\CustomsTaxIdentificationType::Ein,\n ),\n ),\n invoice: '#123123',\n metadata: 'Order ID #123123',\n addressImporter: new Components\\AddressImporter(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: 'Blumenstraße',\n street3: '',\n streetNo: '22',\n city: 'München',\n state: 'CA',\n zip: '80331',\n country: 'DE',\n phone: '80331',\n email: 'shippotle@shippo.com',\n isResidential: true,\n ),\n contentsType: Components\\CustomsDeclarationContentsTypeEnum::Merchandise,\n eelPfc: Components\\CustomsDeclarationEelPfcEnum::NOEEI3037A,\n incoterm: Components\\CustomsDeclarationIncotermEnum::Ddp,\n items: [\n new Components\\CustomsItemCreateRequest(\n description: 'T-Shirt',\n massUnit: Components\\WeightUnitEnum::Lb,\n metadata: 'Order ID \"123454\"',\n netWeight: '5',\n originCountry: '',\n quantity: 20,\n skuCode: 'HM-123',\n hsCode: '0901.21',\n valueAmount: '200',\n valueCurrency: 'USD',\n ),\n ],\n nonDeliveryOption: Components\\CustomsDeclarationNonDeliveryOptionEnum::Return,\n test: true,\n);\n\n$response = $sdk->customsDeclarations->create(\n customsDeclarationCreateRequest: $customsDeclarationCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsDeclaration !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsDeclarations.CreateAsync(\n customsDeclarationCreateRequest: new CustomsDeclarationCreateRequest() {\n B13aFilingOption = CustomsDeclarationB13AFilingOptionEnum.FiledElectronically,\n Certify = true,\n CertifySigner = \"Shawn Ippotle\",\n ContentsExplanation = \"T-Shirt purchase\",\n DutiesPayor = new DutiesPayor() {\n Account = \"2323434543\",\n Type = CustomsDeclarationCreateRequestType.ThirdParty,\n Address = new CustomsDeclarationCreateRequestAddress() {\n Name = \"Patrick Kavanagh\",\n Zip = \"80331\",\n Country = \"DE\",\n },\n },\n ExporterIdentification = new CustomsExporterIdentification() {\n EoriNumber = \"PL123456790ABCDE\",\n TaxId = new CustomsTaxIdentification() {\n Number = \"123456789\",\n Type = CustomsTaxIdentificationType.Ein,\n },\n },\n Invoice = \"#123123\",\n Metadata = \"Order ID #123123\",\n AddressImporter = new AddressImporter() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"Blumenstraße\",\n Street3 = \"\",\n StreetNo = \"22\",\n City = \"München\",\n State = \"CA\",\n Zip = \"80331\",\n Country = \"DE\",\n Phone = \"80331\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n },\n ContentsType = CustomsDeclarationContentsTypeEnum.Merchandise,\n EelPfc = CustomsDeclarationEelPfcEnum.Noeei3037A,\n Incoterm = CustomsDeclarationIncotermEnum.Ddp,\n Items = new List() {\n new CustomsItemCreateRequest() {\n Description = \"T-Shirt\",\n MassUnit = WeightUnitEnum.Lb,\n Metadata = \"Order ID \\\"123454\\\"\",\n NetWeight = \"5\",\n OriginCountry = \"\",\n Quantity = 20,\n SkuCode = \"HM-123\",\n HsCode = \"0901.21\",\n ValueAmount = \"200\",\n ValueCurrency = \"USD\",\n },\n },\n NonDeliveryOption = CustomsDeclarationNonDeliveryOptionEnum.Return,\n Test = true,\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressImporter;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;\nimport com.goshippo.shippo_sdk.models.components.DutiesPayor;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateCustomsDeclarationResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateCustomsDeclarationResponse res = sdk.customsDeclarations().create()\n .shippoApiVersion(\"2018-02-08\")\n .customsDeclarationCreateRequest(CustomsDeclarationCreateRequest.builder()\n .certify(true)\n .certifySigner(\"Shawn Ippotle\")\n .contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)\n .items(List.of(\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build()))\n .nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)\n .b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)\n .contentsExplanation(\"T-Shirt purchase\")\n .dutiesPayor(DutiesPayor.builder()\n .account(\"2323434543\")\n .type(CustomsDeclarationCreateRequestType.THIRD_PARTY)\n .address(CustomsDeclarationCreateRequestAddress.builder()\n .name(\"Patrick Kavanagh\")\n .zip(\"80331\")\n .country(\"DE\")\n .build())\n .build())\n .exporterIdentification(CustomsExporterIdentification.builder()\n .eoriNumber(\"PL123456790ABCDE\")\n .taxId(CustomsTaxIdentification.builder()\n .number(\"123456789\")\n .type(CustomsTaxIdentificationType.EIN)\n .build())\n .build())\n .invoice(\"#123123\")\n .metadata(\"Order ID #123123\")\n .addressImporter(AddressImporter.builder()\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"Blumenstraße\")\n .street3(\"\")\n .streetNo(\"22\")\n .city(\"München\")\n .state(\"CA\")\n .zip(\"80331\")\n .country(\"DE\")\n .phone(\"80331\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .build())\n .eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)\n .incoterm(CustomsDeclarationIncotermEnum.DDP)\n .test(true)\n .build())\n .call();\n\n if (res.customsDeclaration().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/customs/declarations/{CustomsDeclarationId}": { "get": { "description": "Returns an existing customs declaration using an object ID", "operationId": "GetCustomsDeclaration", "parameters": [ { "description": "Object ID of the customs declaration", "in": "path", "name": "CustomsDeclarationId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/customsDeclarationResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a customs declaration", "tags": [ "Customs Declarations" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/declarations/e2197a54da9d470480f4f8796cc419cb \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_declarations.get(customs_declaration_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsDeclarations.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->customsDeclarations->get(\n customsDeclarationId: '',\n page: 1,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsDeclaration !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsDeclarations.GetAsync(\n customsDeclarationId: \"\",\n page: 1,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetCustomsDeclarationResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetCustomsDeclarationResponse res = sdk.customsDeclarations().get()\n .customsDeclarationId(\"\")\n .page(1L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.customsDeclaration().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/customs/items": { "get": { "description": "Returns a list all customs items objects.", "operationId": "ListCustomsItems", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/customsItemPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all customs items", "tags": [ "Customs Items" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/items/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_items.list()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsItems.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->customsItems->list(\n page: 1,\n results: 25,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsItemPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsItems.ListAsync(\n page: 1,\n results: 25,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListCustomsItemsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListCustomsItemsResponse res = sdk.customsItems().list()\n .page(1L)\n .results(25L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.customsItemPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new customs item object.", "operationId": "CreateCustomsItem", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsItemCreateRequest" } } }, "description": "CustomsItem details." }, "responses": { "201": { "$ref": "#/components/responses/customsItemResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new customs item", "tags": [ "Customs Items" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/items/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d description=\"T-Shirt\" \\\n-d quantity=2 \\\n-d net_weight=\"400\" \\\n-d mass_unit=\"g\" \\\n-d value_amount=\"20\" \\\n-d value_currency=\"USD\" \\\n-d tariff_number=\"\" \\\n-d origin_country=\"US\" \\\n-d metadata=\"Order ID '123123'\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_items.create(request=components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsItems.create({\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$customsItemCreateRequest = new Components\\CustomsItemCreateRequest(\n description: 'T-Shirt',\n massUnit: Components\\WeightUnitEnum::Lb,\n metadata: 'Order ID \"123454\"',\n netWeight: '5',\n originCountry: '',\n quantity: 20,\n skuCode: 'HM-123',\n hsCode: '0901.21',\n valueAmount: '200',\n valueCurrency: 'USD',\n);\n\n$response = $sdk->customsItems->create(\n customsItemCreateRequest: $customsItemCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsItem !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsItems.CreateAsync(\n customsItemCreateRequest: new CustomsItemCreateRequest() {\n Description = \"T-Shirt\",\n MassUnit = WeightUnitEnum.Lb,\n Metadata = \"Order ID \\\"123454\\\"\",\n NetWeight = \"5\",\n OriginCountry = \"\",\n Quantity = 20,\n SkuCode = \"HM-123\",\n HsCode = \"0901.21\",\n ValueAmount = \"200\",\n ValueCurrency = \"USD\",\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateCustomsItemResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateCustomsItemResponse res = sdk.customsItems().create()\n .shippoApiVersion(\"2018-02-08\")\n .customsItemCreateRequest(CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build())\n .call();\n\n if (res.customsItem().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/customs/items/{CustomsItemId}": { "get": { "description": "Returns an existing customs item using an object ID", "operationId": "GetCustomsItem", "parameters": [ { "description": "Object ID of the customs item", "in": "path", "name": "CustomsItemId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/customsItemResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a customs item", "tags": [ "Customs Items" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/customs/items/55358464c7b740aca199b395536981bd \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.customs_items.get(customs_item_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.customsItems.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->customsItems->get(\n customsItemId: '',\n page: 1,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->customsItem !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CustomsItems.GetAsync(\n customsItemId: \"\",\n page: 1,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetCustomsItemResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetCustomsItemResponse res = sdk.customsItems().get()\n .customsItemId(\"\")\n .page(1L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.customsItem().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/live-rates": { "post": { "description": "Initiates a live rates request. Include either the object ID for\nan existing address record or a fully formed address object when entering\nan address value. You can also enter the object ID of an existing user parcel\ntemplate or a fully formed user parcel template object as the parcel value.", "operationId": "CreateLiveRate", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveRateCreateRequest" } } }, "description": "Generate rates at checkout" }, "responses": { "200": { "$ref": "#/components/responses/liveRatePaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Generate a live rates request", "tags": [ "Rates at Checkout" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/live-rates \\\n -H \"Authorization: ShippoToken \" \\\n -H \"Content-Type: application/json\"\n--data-raw '{\n \"address_from\": {\n \"name\": \"S. Hippo\",\n \"company\": \"Shippo\",\n \"street1\": \"731 Market St #200\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\"\n },\n \"address_to\": {\n \"name\": \"Bob Bloat\",\n \"company\": \"SF Zoo\",\n \"street1\": \"Sloat Blvd. & Upper Great Hwy.\",\n \"street_no\": \"\",\n \"street2\": \"\",\n \"street3\": \"\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94132\",\n \"country\": \"US\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"total_price\": \"12.00\",\n \"currency\": \"USD\",\n \"weight\": \"1.0\",\n \"weight_unit\": \"lb\",\n \"title\": \"Hippo Snax\",\n \"manufacture_country\": \"US\",\n \"sku\": \"HM-123\"\n }\n ],\n \"parcel\": {\n \"length\": \"10\",\n \"width\": \"15\",\n \"height\": \"10\",\n \"distance_unit\": \"in\",\n \"weight\": \"1\",\n \"mass_unit\": \"lb\"\n }\n}'" }, { "lang": "python", "label": "Python", "source": "import dateutil.parser\nimport shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates_at_checkout.create(request=components.LiveRateCreateRequest(\n address_from='',\n address_to=components.AddressCompleteCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n line_items=[\n components.LineItem(\n currency='USD',\n manufacture_country='US',\n max_delivery_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n max_ship_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n quantity=20,\n sku='HM-123',\n title='Hippo Magazines',\n total_price='12.1',\n variant_title='June Edition',\n weight='0.4',\n weight_unit=components.WeightUnitEnum.LB,\n object_id='abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel='5df144dca289442cv7a06',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.ratesAtCheckout.create({\n addressFrom: \"\",\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n lineItems: [\n {\n currency: \"USD\",\n manufactureCountry: \"US\",\n maxDeliveryTime: new Date(\"2016-07-23T00:00:00Z\"),\n maxShipTime: new Date(\"2016-07-23T00:00:00Z\"),\n quantity: 20,\n sku: \"HM-123\",\n title: \"Hippo Magazines\",\n totalPrice: \"12.1\",\n variantTitle: \"June Edition\",\n weight: \"0.4\",\n weightUnit: \"lb\",\n objectId: \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n ],\n parcel: \"5df144dca289442cv7a06\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.RatesAtCheckout.CreateAsync(\n liveRateCreateRequest: new LiveRateCreateRequest() {\n AddressFrom = LiveRateCreateRequestAddressFrom.CreateStr(\n \"\"\n ),\n AddressTo = LiveRateCreateRequestAddressTo.CreateAddressCompleteCreateRequest(\n new AddressCompleteCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n LineItems = new List() {\n new LineItem() {\n Currency = \"USD\",\n ManufactureCountry = \"US\",\n MaxDeliveryTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n MaxShipTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n Quantity = 20,\n Sku = \"HM-123\",\n Title = \"Hippo Magazines\",\n TotalPrice = \"12.1\",\n VariantTitle = \"June Edition\",\n Weight = \"0.4\",\n WeightUnit = WeightUnitEnum.Lb,\n ObjectId = \"abf7d5675d744b6ea9fdb6f796b28f28\",\n },\n },\n Parcel = LiveRateCreateRequestParcel.CreateStr(\n \"5df144dca289442cv7a06\"\n ),\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Utils;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$liveRateCreateRequest = new Components\\LiveRateCreateRequest(\n addressFrom: '',\n addressTo: new Components\\AddressCompleteCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n lineItems: [\n new Components\\LineItem(\n currency: 'USD',\n manufactureCountry: 'US',\n maxDeliveryTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n maxShipTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n quantity: 20,\n sku: 'HM-123',\n title: 'Hippo Magazines',\n totalPrice: '12.1',\n variantTitle: 'June Edition',\n weight: '0.4',\n weightUnit: Components\\WeightUnitEnum::Lb,\n objectId: 'abf7d5675d744b6ea9fdb6f796b28f28',\n ),\n ],\n parcel: '5df144dca289442cv7a06',\n);\n\n$response = $sdk->ratesAtCheckout->create(\n liveRateCreateRequest: $liveRateCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->liveRatePaginatedList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCompleteCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LineItem;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressFrom;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestAddressTo;\nimport com.goshippo.shippo_sdk.models.components.LiveRateCreateRequestParcel;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateLiveRateResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateLiveRateResponse res = sdk.ratesAtCheckout().create()\n .shippoApiVersion(\"2018-02-08\")\n .liveRateCreateRequest(LiveRateCreateRequest.builder()\n .addressTo(LiveRateCreateRequestAddressTo.of(AddressCompleteCreateRequest.builder()\n .name(\"Shwan Ippotle\")\n .street1(\"215 Clayton St.\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .country(\"US\")\n .company(\"Shippo\")\n .street3(\"\")\n .streetNo(\"\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .lineItems(List.of(\n LineItem.builder()\n .currency(\"USD\")\n .manufactureCountry(\"US\")\n .maxDeliveryTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .maxShipTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .quantity(20L)\n .sku(\"HM-123\")\n .title(\"Hippo Magazines\")\n .totalPrice(\"12.1\")\n .variantTitle(\"June Edition\")\n .weight(\"0.4\")\n .weightUnit(WeightUnitEnum.LB)\n .objectId(\"abf7d5675d744b6ea9fdb6f796b28f28\")\n .build()))\n .addressFrom(LiveRateCreateRequestAddressFrom.of(\"\"))\n .parcel(LiveRateCreateRequestParcel.of(\"5df144dca289442cv7a06\"))\n .build())\n .call();\n\n if (res.liveRatePaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/live-rates/settings/parcel-template": { "get": { "description": "Retrieve and display the currently configured default parcel template for live rates.", "operationId": "GetDefaultParcelTemplate", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/defaultParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Show current default parcel template", "tags": [ "Rates at Checkout" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/live-rates/settings/parcel-template \\\n -H \"Authorization: ShippoToken \" \\\n -H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates_at_checkout.get_default_parcel_template(request=operations.GetDefaultParcelTemplateRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.ratesAtCheckout.getDefaultParcelTemplate({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.RatesAtCheckout.GetDefaultParcelTemplateAsync(shippoApiVersion: \"2018-02-08\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->ratesAtCheckout->getDefaultParcelTemplate(\n shippoApiVersion: '2018-02-08'\n);\n\nif ($response->defaultParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetDefaultParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetDefaultParcelTemplateResponse res = sdk.ratesAtCheckout().getDefaultParcelTemplate()\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.defaultParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "getDefaultParcelTemplate" }, "put": { "description": "Update the currently configured default parcel template for live rates. The object_id in the request payload should identify the user parcel template to be the new default.", "operationId": "UpdateDefaultParcelTemplate", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultParcelTemplateUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/defaultParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Update default parcel template", "tags": [ "Rates at Checkout" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X PUT https://api.goshippo.com/live-rates/settings/parcel-template \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d '\n {\n \"object_id\": \"b958d3690bb04bb8b2986724872750f5\"\n }\n'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates_at_checkout.update_default_parcel_template(request=components.DefaultParcelTemplateUpdateRequest(\n object_id='b958d3690bb04bb8b2986724872750f5',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.ratesAtCheckout.updateDefaultParcelTemplate({\n objectId: \"b958d3690bb04bb8b2986724872750f5\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.RatesAtCheckout.UpdateDefaultParcelTemplateAsync(\n shippoApiVersion: \"2018-02-08\",\n defaultParcelTemplateUpdateRequest: new DefaultParcelTemplateUpdateRequest() {\n ObjectId = \"b958d3690bb04bb8b2986724872750f5\",\n }\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$defaultParcelTemplateUpdateRequest = new Components\\DefaultParcelTemplateUpdateRequest(\n objectId: 'b958d3690bb04bb8b2986724872750f5',\n);\n\n$response = $sdk->ratesAtCheckout->updateDefaultParcelTemplate(\n shippoApiVersion: '2018-02-08',\n defaultParcelTemplateUpdateRequest: $defaultParcelTemplateUpdateRequest\n\n);\n\nif ($response->defaultParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.DefaultParcelTemplateUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.UpdateDefaultParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateDefaultParcelTemplateResponse res = sdk.ratesAtCheckout().updateDefaultParcelTemplate()\n .shippoApiVersion(\"2018-02-08\")\n .defaultParcelTemplateUpdateRequest(DefaultParcelTemplateUpdateRequest.builder()\n .objectId(\"b958d3690bb04bb8b2986724872750f5\")\n .build())\n .call();\n\n if (res.defaultParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "updateDefaultParcelTemplate" }, "delete": { "description": "Clears the currently configured default parcel template for live rates.", "operationId": "DeleteDefaultParcelTemplate", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "204": { "description": "The parcel template was successfully deleted." }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Clear current default parcel template", "tags": [ "Rates at Checkout" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X DELETE https://api.goshippo.com/live-rates/settings/parcel-template \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\ns.rates_at_checkout.delete_default_parcel_template(request=operations.DeleteDefaultParcelTemplateRequest())\n\n# Use the SDK ..." }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n await shippo.ratesAtCheckout.deleteDefaultParcelTemplate({});\n\n\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nawait sdk.RatesAtCheckout.DeleteDefaultParcelTemplateAsync(shippoApiVersion: \"2018-02-08\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->ratesAtCheckout->deleteDefaultParcelTemplate(\n shippoApiVersion: '2018-02-08'\n);\n\nif ($response->statusCode === 200) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.DeleteDefaultParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n DeleteDefaultParcelTemplateResponse res = sdk.ratesAtCheckout().deleteDefaultParcelTemplate()\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n // handle response\n }\n}" } ], "x-speakeasy-name-override": "deleteDefaultParcelTemplate" } }, "/manifests": { "get": { "description": "Returns a list of all manifest objects.", "operationId": "ListManifests", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageDefault5QueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/manifestPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all manifests", "tags": [ "Manifests" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/manifests/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.manifests.list()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.manifests.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->manifests->list(\n page: 1,\n results: 5,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->manifestPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Manifests.ListAsync(\n page: 1,\n results: 5,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListManifestsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListManifestsResponse res = sdk.manifests().list()\n .page(1L)\n .results(5L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.manifestPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new manifest object.", "operationId": "CreateManifest", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestCreateRequest" } } }, "description": "Manifest details and contact info." }, "responses": { "201": { "$ref": "#/components/responses/manifestResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new manifest", "tags": [ "Manifests" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/manifests/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d carrier_account=\"b741b99f95e841639b54272834bc478c\", \\\n-d shipment_date=\"2014-05-16T23:59:59Z\" \\\n-d address_from=\"d799c2679e644279b59fe661ac8fa488\" \\\n-d transactions=[\"64bba01845ef40d29374032599f22588\", \"c169aa586a844cc49da00d0272b590e1\"] \\\n-d async=false" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.manifests.create(request=components.ManifestCreateRequest(\n carrier_account='adcfdddf8ec64b84ad22772bce3ea37a',\n shipment_date='2014-05-16T23:59:59Z',\n transactions=[\n 'adcfdddf8ec64b84ad22772bce3ea37a',\n ],\n address_from=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.manifests.create({\n carrierAccount: \"adcfdddf8ec64b84ad22772bce3ea37a\",\n shipmentDate: \"2014-05-16T23:59:59Z\",\n transactions: [\n \"adcfdddf8ec64b84ad22772bce3ea37a\",\n ],\n addressFrom: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$manifestCreateRequest = new Components\\ManifestCreateRequest(\n carrierAccount: 'adcfdddf8ec64b84ad22772bce3ea37a',\n shipmentDate: '2014-05-16T23:59:59Z',\n transactions: [\n 'adcfdddf8ec64b84ad22772bce3ea37a',\n ],\n addressFrom: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n);\n\n$response = $sdk->manifests->create(\n manifestCreateRequest: $manifestCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->manifest !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Manifests.CreateAsync(\n manifestCreateRequest: new ManifestCreateRequest() {\n CarrierAccount = \"adcfdddf8ec64b84ad22772bce3ea37a\",\n ShipmentDate = \"2014-05-16T23:59:59Z\",\n Transactions = new List() {\n \"adcfdddf8ec64b84ad22772bce3ea37a\",\n },\n AddressFrom = ManifestCreateRequestAddressFrom.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ManifestCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ManifestCreateRequestAddressFrom;\nimport com.goshippo.shippo_sdk.models.operations.CreateManifestResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateManifestResponse res = sdk.manifests().create()\n .shippoApiVersion(\"2018-02-08\")\n .manifestCreateRequest(ManifestCreateRequest.builder()\n .carrierAccount(\"adcfdddf8ec64b84ad22772bce3ea37a\")\n .shipmentDate(\"2014-05-16T23:59:59Z\")\n .addressFrom(ManifestCreateRequestAddressFrom.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .transactions(List.of(\n \"adcfdddf8ec64b84ad22772bce3ea37a\"))\n .build())\n .call();\n\n if (res.manifest().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/manifests/{ManifestId}": { "get": { "description": "Returns an existing manifest using an object ID.", "operationId": "GetManifest", "parameters": [ { "description": "Object ID of the manifest to update", "in": "path", "name": "ManifestId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/manifestResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a manifest", "tags": [ "Manifests" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/manifests/0fadebf6f60c4aca95fa01bcc59c79ae \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.manifests.get(manifest_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.manifests.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->manifests->get(\n manifestId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->manifest !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Manifests.GetAsync(\n manifestId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetManifestResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetManifestResponse res = sdk.manifests().get()\n .manifestId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.manifest().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/orders": { "get": { "description": "Returns a list of all order objects.", "operationId": "ListOrders", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" }, { "description": "Filter orders by order status", "in": "query", "name": "order_status[]", "required": false, "schema": { "items": { "$ref": "#/components/schemas/OrderStatusEnum" }, "type": "array" } }, { "description": "Filter orders by shop app", "in": "query", "name": "shop_app", "required": false, "schema": { "$ref": "#/components/schemas/OrderShopAppEnum" } }, { "description": "Filter orders created after the input date and time (ISO 8601 UTC format). This is based on the \n`placed_at` field, meaning when the order has been placed, not when the order object was created.", "in": "query", "name": "start_date", "required": false, "schema": { "type": "string" } }, { "description": "Filter orders created before the input date and time (ISO 8601 UTC format). This is based on the \n`placed_at` field, meaning when the order has been placed, not when the order object was created.", "in": "query", "name": "end_date", "required": false, "schema": { "type": "string" } } ], "responses": { "200": { "$ref": "#/components/responses/orderPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all orders", "tags": [ "Orders" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/orders/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components, operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.orders.list(request=operations.ListOrdersRequest(\n order_status=[\n components.OrderStatusEnum.PAID,\n ],\n shop_app=components.OrderShopAppEnum.SHIPPO,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.orders.list({\n orderStatus: [\n \"PAID\",\n ],\n shopApp: \"Shippo\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListOrdersRequest req = new ListOrdersRequest() {\n OrderStatus = new List() {\n OrderStatusEnum.Paid,\n },\n ShopApp = OrderShopAppEnum.Shippo,\n};\n\nvar res = await sdk.Orders.ListAsync(req);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListOrdersRequest(\n orderStatus: [\n Components\\OrderStatusEnum::Paid,\n ],\n shopApp: Components\\OrderShopAppEnum::Shippo,\n);\n\n$response = $sdk->orders->list(\n request: $request\n);\n\nif ($response->orderPaginatedList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.OrderShopAppEnum;\nimport com.goshippo.shippo_sdk.models.components.OrderStatusEnum;\nimport com.goshippo.shippo_sdk.models.operations.ListOrdersRequest;\nimport com.goshippo.shippo_sdk.models.operations.ListOrdersResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListOrdersRequest req = ListOrdersRequest.builder()\n .orderStatus(List.of(\n OrderStatusEnum.PAID))\n .shopApp(OrderShopAppEnum.SHIPPO)\n .build();\n\n ListOrdersResponse res = sdk.orders().list()\n .request(req)\n .call();\n\n if (res.orderPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new order object.", "operationId": "CreateOrder", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderCreateRequest" } } }, "description": "Order details." }, "responses": { "201": { "$ref": "#/components/responses/orderResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new order", "tags": [ "Orders" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/orders/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d '{\n \"to_address\": {\n \"city\": \"San Francisco\",\n \"company\": \"Shippo\",\n \"country\": \"US\",\n \"email\": \"shippotle@shippo.com\",\n \"name\": \"Mr Hippo\",\n \"phone\": \"15553419393\",\n \"state\": \"CA\",\n \"street1\": \"215 Clayton St.\",\n \"zip\": \"94117\"\n },\n \"line_items\": [\n {\n \"quantity\": 1,\n \"sku\": \"HM-123\",\n \"title\": \"Hippo Magazines\",\n \"total_price\": \"12.10\",\n \"currency\": \"USD\",\n \"weight\": \"0.40\",\n \"weight_unit\": \"lb\"\n }\n ],\n \"placed_at\": \"2016-09-23T01:28:12Z\",\n \"order_number\": \"#1068\",\n \"order_status\": \"PAID\",\n \"shipping_cost\": \"12.83\",\n \"shipping_cost_currency\": \"USD\",\n \"shipping_method\": \"USPS First Class Package\",\n \"subtotal_price\": \"12.10\",\n \"total_price\": \"24.93\",\n \"total_tax\": \"0.00\",\n \"currency\": \"USD\",\n \"weight\": \"0.40\",\n \"weight_unit\": \"lb\"\n }'" }, { "lang": "python", "label": "Python", "source": "import dateutil.parser\nimport shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.orders.create(request=components.OrderCreateRequest(\n currency='USD',\n notes='This customer is a VIP',\n order_number='#1068',\n order_status=components.OrderStatusEnum.PAID,\n placed_at='2016-09-23T01:28:12Z',\n shipping_cost='12.83',\n shipping_cost_currency='USD',\n shipping_method='USPS First Class Package',\n subtotal_price='12.1',\n total_price='24.93',\n total_tax='0.0',\n weight='0.4',\n weight_unit=components.WeightUnitEnum.LB,\n from_address=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n to_address=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n line_items=[\n components.LineItemBase(\n currency='USD',\n manufacture_country='US',\n max_delivery_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n max_ship_time=dateutil.parser.isoparse('2016-07-23T00:00:00Z'),\n quantity=20,\n sku='HM-123',\n title='Hippo Magazines',\n total_price='12.1',\n variant_title='June Edition',\n weight='0.4',\n weight_unit=components.WeightUnitEnum.LB,\n ),\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.orders.create({\n currency: \"USD\",\n notes: \"This customer is a VIP\",\n orderNumber: \"#1068\",\n orderStatus: \"PAID\",\n placedAt: \"2016-09-23T01:28:12Z\",\n shippingCost: \"12.83\",\n shippingCostCurrency: \"USD\",\n shippingMethod: \"USPS First Class Package\",\n subtotalPrice: \"12.1\",\n totalPrice: \"24.93\",\n totalTax: \"0.0\",\n weight: \"0.4\",\n weightUnit: \"lb\",\n fromAddress: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n toAddress: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n lineItems: [\n {\n currency: \"USD\",\n manufactureCountry: \"US\",\n maxDeliveryTime: new Date(\"2016-07-23T00:00:00Z\"),\n maxShipTime: new Date(\"2016-07-23T00:00:00Z\"),\n quantity: 20,\n sku: \"HM-123\",\n title: \"Hippo Magazines\",\n totalPrice: \"12.1\",\n variantTitle: \"June Edition\",\n weight: \"0.4\",\n weightUnit: \"lb\",\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Orders.CreateAsync(\n orderCreateRequest: new OrderCreateRequest() {\n Currency = \"USD\",\n Notes = \"This customer is a VIP\",\n OrderNumber = \"#1068\",\n OrderStatus = OrderStatusEnum.Paid,\n PlacedAt = \"2016-09-23T01:28:12Z\",\n ShippingCost = \"12.83\",\n ShippingCostCurrency = \"USD\",\n ShippingMethod = \"USPS First Class Package\",\n SubtotalPrice = \"12.1\",\n TotalPrice = \"24.93\",\n TotalTax = \"0.0\",\n Weight = \"0.4\",\n WeightUnit = WeightUnitEnum.Lb,\n FromAddress = new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n },\n ToAddress = new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n },\n LineItems = new List() {\n new LineItemBase() {\n Currency = \"USD\",\n ManufactureCountry = \"US\",\n MaxDeliveryTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n MaxShipTime = System.DateTime.Parse(\"2016-07-23T00:00:00Z\"),\n Quantity = 20,\n Sku = \"HM-123\",\n Title = \"Hippo Magazines\",\n TotalPrice = \"12.1\",\n VariantTitle = \"June Edition\",\n Weight = \"0.4\",\n WeightUnit = WeightUnitEnum.Lb,\n },\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Utils;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$orderCreateRequest = new Components\\OrderCreateRequest(\n currency: 'USD',\n notes: 'This customer is a VIP',\n orderNumber: '#1068',\n orderStatus: Components\\OrderStatusEnum::Paid,\n placedAt: '2016-09-23T01:28:12Z',\n shippingCost: '12.83',\n shippingCostCurrency: 'USD',\n shippingMethod: 'USPS First Class Package',\n subtotalPrice: '12.1',\n totalPrice: '24.93',\n totalTax: '0.0',\n weight: '0.4',\n weightUnit: Components\\WeightUnitEnum::Lb,\n fromAddress: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n toAddress: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n lineItems: [\n new Components\\LineItemBase(\n currency: 'USD',\n manufactureCountry: 'US',\n maxDeliveryTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n maxShipTime: Utils\\Utils::parseDateTime('2016-07-23T00:00:00Z'),\n quantity: 20,\n sku: 'HM-123',\n title: 'Hippo Magazines',\n totalPrice: '12.1',\n variantTitle: 'June Edition',\n weight: '0.4',\n weightUnit: Components\\WeightUnitEnum::Lb,\n ),\n ],\n);\n\n$response = $sdk->orders->create(\n orderCreateRequest: $orderCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->order !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.LineItemBase;\nimport com.goshippo.shippo_sdk.models.components.OrderCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.OrderStatusEnum;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateOrderResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateOrderResponse res = sdk.orders().create()\n .shippoApiVersion(\"2018-02-08\")\n .orderCreateRequest(OrderCreateRequest.builder()\n .placedAt(\"2016-09-23T01:28:12Z\")\n .toAddress(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build())\n .currency(\"USD\")\n .notes(\"This customer is a VIP\")\n .orderNumber(\"#1068\")\n .orderStatus(OrderStatusEnum.PAID)\n .shippingCost(\"12.83\")\n .shippingCostCurrency(\"USD\")\n .shippingMethod(\"USPS First Class Package\")\n .subtotalPrice(\"12.1\")\n .totalPrice(\"24.93\")\n .totalTax(\"0.0\")\n .weight(\"0.4\")\n .weightUnit(WeightUnitEnum.LB)\n .fromAddress(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build())\n .lineItems(List.of(\n LineItemBase.builder()\n .currency(\"USD\")\n .manufactureCountry(\"US\")\n .maxDeliveryTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .maxShipTime(OffsetDateTime.parse(\"2016-07-23T00:00:00Z\"))\n .quantity(20L)\n .sku(\"HM-123\")\n .title(\"Hippo Magazines\")\n .totalPrice(\"12.1\")\n .variantTitle(\"June Edition\")\n .weight(\"0.4\")\n .weightUnit(WeightUnitEnum.LB)\n .build()))\n .build())\n .call();\n\n if (res.order().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/orders/{OrderId}": { "get": { "description": "Retrieves an existing order using an object ID.", "operationId": "GetOrder", "parameters": [ { "description": "Object ID of the order", "in": "path", "name": "OrderId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/orderResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve an order", "tags": [ "Orders" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/orders/4f2bc588e4e5446cb3f9fdb7cd5e190b/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.orders.get(order_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.orders.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Orders.GetAsync(\n orderId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->orders->get(\n orderId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->order !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetOrderResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetOrderResponse res = sdk.orders().get()\n .orderId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.order().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/parcel-templates": { "get": { "description": "List all carrier parcel template objects.
Use the following query string params to filter the results as needed.
\n
    \n
  • `include=all` (the default). Includes templates from all carriers
    • \n
  • `include=user`. Includes templates only from carriers which the user has added (whether or not they're currently enabled)
    • \n
  • `include=enabled`. includes templates only for carriers which the user has added and enabled
    • \n
  • `carrier=*token*`. filter by specific carrier, e.g. fedex, usps
    • \n
", "operationId": "ListCarrierParcelTemplates", "parameters": [ { "name": "include", "description": "filter by user or enabled", "in": "query", "schema": { "type": "string", "enum": [ "all", "user", "enabled" ] } }, { "name": "carrier", "description": "filter by specific carrier", "example": "fedex", "in": "query", "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/carrierParcelTemplateListResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all carrier parcel templates", "tags": [ "Carrier Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/parcel-templates \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_parcel_templates.list(carrier='fedex')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierParcelTemplates.list(\"fedex\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierParcelTemplates.ListAsync(\n include: Include.Enabled,\n carrier: \"fedex\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->carrierParcelTemplates->list(\n include: Operations\\IncludeT::Enabled,\n carrier: 'fedex',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierParcelTemplateList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.Include;\nimport com.goshippo.shippo_sdk.models.operations.ListCarrierParcelTemplatesResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListCarrierParcelTemplatesResponse res = sdk.carrierParcelTemplates().list()\n .include(Include.ENABLED)\n .carrier(\"fedex\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.carrierParcelTemplateList().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/parcel-templates/{CarrierParcelTemplateToken}": { "get": { "description": "Fetches the parcel template information for a specific carrier parcel template, identified by the token.", "operationId": "GetCarrierParcelTemplate", "parameters": [ { "description": "The unique string representation of the carrier parcel template", "in": "path", "name": "CarrierParcelTemplateToken", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/carrierParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a carrier parcel templates", "tags": [ "Carrier Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/parcel-templates/Fedex_Box_Small_1 \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.carrier_parcel_templates.get(carrier_parcel_template_token='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.carrierParcelTemplates.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.CarrierParcelTemplates.GetAsync(\n carrierParcelTemplateToken: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->carrierParcelTemplates->get(\n carrierParcelTemplateToken: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->carrierParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetCarrierParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetCarrierParcelTemplateResponse res = sdk.carrierParcelTemplates().get()\n .carrierParcelTemplateToken(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.carrierParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/parcels": { "get": { "description": "Returns a list of all parcel objects.", "operationId": "ListParcels", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/parcelPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all parcels", "tags": [ "Parcels" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/parcels/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.parcels.list()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.parcels.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->parcels->list(\n page: 1,\n results: 25,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->parcelPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Parcels.ListAsync(\n page: 1,\n results: 25,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListParcelsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListParcelsResponse res = sdk.parcels().list()\n .page(1L)\n .results(25L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.parcelPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new parcel object.", "operationId": "CreateParcel", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/ParcelCreateRequest" }, { "$ref": "#/components/schemas/ParcelCreateFromTemplateRequest" } ] } } }, "description": "Parcel details." }, "responses": { "201": { "$ref": "#/components/responses/parcelResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new parcel", "tags": [ "Parcels" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/parcels/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n -d length=5 \\\n -d width=5 \\\n -d height=5 \\\n -d distance_unit=\"cm\" \\\n -d weight=2 \\\n -d mass_unit=\"lb\" \\\n -d template=\"\" \\\n -d metadata=\"Customer ID 123456\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.parcels.create(request=components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.parcels.create({\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->parcels->create(\n requestBody: new Components\\ParcelCreateRequest(\n extra: new Components\\ParcelExtra(\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n insurance: new Components\\ParcelInsurance(\n amount: '5.5',\n content: 'Laptop',\n currency: 'USD',\n provider: Components\\ParcelInsuranceProvider::Ups,\n ),\n ),\n metadata: 'Customer ID 123456',\n massUnit: Components\\WeightUnitEnum::Lb,\n weight: '1',\n distanceUnit: Components\\DistanceUnitEnum::In,\n height: '1',\n length: '1',\n width: '1',\n ),\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->parcel !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Parcels.CreateAsync(\n requestBody: CreateParcelRequestBody.CreateParcelCreateRequest(\n new ParcelCreateRequest() {\n Extra = new ParcelExtra() {\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n Insurance = new ParcelInsurance() {\n Amount = \"5.5\",\n Content = \"Laptop\",\n Currency = \"USD\",\n Provider = ParcelInsuranceProvider.Ups,\n },\n },\n Metadata = \"Customer ID 123456\",\n MassUnit = WeightUnitEnum.Lb,\n Weight = \"1\",\n DistanceUnit = DistanceUnitEnum.In,\n Height = \"1\",\n Length = \"1\",\n Width = \"1\",\n }\n ),\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.Cod;\nimport com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;\nimport com.goshippo.shippo_sdk.models.components.ParcelCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ParcelExtra;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsurance;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;\nimport com.goshippo.shippo_sdk.models.components.PaymentMethod;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateParcelRequestBody;\nimport com.goshippo.shippo_sdk.models.operations.CreateParcelResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateParcelResponse res = sdk.parcels().create()\n .shippoApiVersion(\"2018-02-08\")\n .requestBody(CreateParcelRequestBody.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build()))\n .call();\n\n if (res.parcel().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/parcels/{ParcelId}": { "get": { "description": "Returns parcel details using an existing parcel object ID (this will not return parcel details associated with un-purchased shipment/rate parcel object IDs).", "operationId": "GetParcel", "parameters": [ { "description": "Object ID of the parcel", "in": "path", "name": "ParcelId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/parcelResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve an existing parcel", "tags": [ "Parcels" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/parcels/7df2ecf8b4224763ab7c71fae7ec8274/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.parcels.get(parcel_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.parcels.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->parcels->get(\n parcelId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->parcel !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Parcels.GetAsync(\n parcelId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetParcelResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetParcelResponse res = sdk.parcels().get()\n .parcelId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.parcel().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/pickups": { "post": { "description": "Creates a pickup object. This request is for a carrier to come to a specified location to take a package for shipping.", "operationId": "CreatePickup", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PickupCreateRequest" } } }, "description": "Shippo’s pickups endpoint allows you to schedule pickups with USPS and DHL Express for eligible shipments that you have already created." }, "responses": { "201": { "$ref": "#/components/responses/pickupResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a pickup", "tags": [ "Pickups" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/pickups/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"carrier_account\":\"6c51273296864869829b96a80fb13ea1\",\n \"location\":{\n \"building_location_type\": \"Other\",\n \"building_type\": \"suite\",\n \"instructions\": \"Behind screen door\",\n \"address\": {\n \"name\": \"Mrs Hippo\",\n \"company\": \"Hungry Hippos\",\n \"street1\": \"965 Mission St #201\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"95122\",\n \"country\": \"US\",\n \"phone\": \"+14159876543\",\n \"email\": \"mrshippo@shippo.com\"\n }\n },\n \"transactions\": [\"7439c279b374494c9a80ca24f59e6fc5\"],\n \"requested_start_time\":\"2020-05-12T12:00:00Z\",\n \"requested_end_time\": \"2020-05-12T16:00:00Z\",\n \"metadata\": \"Customer ID 123456\",\n \"is_test\": false\n }'" }, { "lang": "python", "label": "Python", "source": "import dateutil.parser\nimport shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.pickups.create(request=components.PickupBase(\n carrier_account='adcfdddf8ec64b84ad22772bce3ea37a',\n location=components.Location(\n address=components.AddressCompleteCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n building_location_type=components.BuildingLocationType.FRONT_DOOR,\n building_type=components.BuildingType.APARTMENT,\n instructions='Behind screen door',\n ),\n requested_end_time=dateutil.parser.isoparse('2024-06-17T07:14:55.338Z'),\n requested_start_time=dateutil.parser.isoparse('2024-11-30T17:06:07.804Z'),\n transactions=[\n 'adcfdddf8ec64b84ad22772bce3ea37a',\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.pickups.create({\n carrierAccount: \"adcfdddf8ec64b84ad22772bce3ea37a\",\n location: {\n address: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n buildingLocationType: \"Front Door\",\n buildingType: \"apartment\",\n instructions: \"Behind screen door\",\n },\n requestedEndTime: new Date(\"2024-06-17T07:14:55.338Z\"),\n requestedStartTime: new Date(\"2024-11-30T17:06:07.804Z\"),\n transactions: [\n \"adcfdddf8ec64b84ad22772bce3ea37a\",\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Pickups.CreateAsync(\n pickupBase: new PickupBase() {\n CarrierAccount = \"adcfdddf8ec64b84ad22772bce3ea37a\",\n Location = new Location() {\n Address = new AddressCompleteCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n },\n BuildingLocationType = BuildingLocationType.FrontDoor,\n BuildingType = BuildingType.Apartment,\n Instructions = \"Behind screen door\",\n },\n RequestedEndTime = System.DateTime.Parse(\"2024-06-17T07:14:55.338Z\"),\n RequestedStartTime = System.DateTime.Parse(\"2024-11-30T17:06:07.804Z\"),\n Transactions = new List() {\n \"adcfdddf8ec64b84ad22772bce3ea37a\",\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Utils;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$pickupBase = new Components\\PickupBase(\n carrierAccount: 'adcfdddf8ec64b84ad22772bce3ea37a',\n location: new Components\\Location(\n address: new Components\\AddressCompleteCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n buildingLocationType: Components\\BuildingLocationType::FrontDoor,\n buildingType: Components\\BuildingType::Apartment,\n instructions: 'Behind screen door',\n ),\n requestedEndTime: Utils\\Utils::parseDateTime('2024-06-17T07:14:55.338Z'),\n requestedStartTime: Utils\\Utils::parseDateTime('2024-11-30T17:06:07.804Z'),\n transactions: [\n 'adcfdddf8ec64b84ad22772bce3ea37a',\n ],\n);\n\n$response = $sdk->pickups->create(\n pickupBase: $pickupBase,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->pickup !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCompleteCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.BuildingLocationType;\nimport com.goshippo.shippo_sdk.models.components.BuildingType;\nimport com.goshippo.shippo_sdk.models.components.Location;\nimport com.goshippo.shippo_sdk.models.components.PickupBase;\nimport com.goshippo.shippo_sdk.models.operations.CreatePickupResponse;\nimport java.lang.Exception;\nimport java.time.OffsetDateTime;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreatePickupResponse res = sdk.pickups().create()\n .shippoApiVersion(\"2018-02-08\")\n .pickupBase(PickupBase.builder()\n .carrierAccount(\"adcfdddf8ec64b84ad22772bce3ea37a\")\n .location(Location.builder()\n .address(AddressCompleteCreateRequest.builder()\n .name(\"Shwan Ippotle\")\n .street1(\"215 Clayton St.\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .country(\"US\")\n .company(\"Shippo\")\n .street3(\"\")\n .streetNo(\"\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build())\n .buildingLocationType(BuildingLocationType.FRONT_DOOR)\n .buildingType(BuildingType.APARTMENT)\n .instructions(\"Behind screen door\")\n .build())\n .requestedEndTime(OffsetDateTime.parse(\"2024-06-17T07:14:55.338Z\"))\n .requestedStartTime(OffsetDateTime.parse(\"2024-11-30T17:06:07.804Z\"))\n .transactions(List.of(\n \"adcfdddf8ec64b84ad22772bce3ea37a\"))\n .build())\n .call();\n\n if (res.pickup().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/rates/{RateId}": { "get": { "description": "Returns an existing rate using a rate object ID.", "operationId": "GetRate", "parameters": [ { "description": "Object ID of the rate", "in": "path", "name": "RateId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/rateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a rate", "tags": [ "Rates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/rates/ee81fab0372e419ab52245c8952ccaeb \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates.get(rate_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.rates.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->rates->get(\n rateId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->rate !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Rates.GetAsync(\n rateId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetRateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetRateResponse res = sdk.rates().get()\n .rateId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.rate().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/refunds": { "post": { "description": "Creates a new refund object.", "operationId": "CreateRefund", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundRequestBody" } } }, "description": "Refund details" }, "responses": { "201": { "$ref": "#/components/responses/refundResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a refund", "tags": [ "Refunds" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/refunds/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d transaction=\"4503427478ea45a899e9b54abc4c5803\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.refunds.create(request=components.RefundRequestBody(\n async_=False,\n transaction='915d94940ea54c3a80cbfa328722f5a1',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.refunds.create({\n async: false,\n transaction: \"915d94940ea54c3a80cbfa328722f5a1\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$refundRequestBody = new Components\\RefundRequestBody(\n async: false,\n transaction: '915d94940ea54c3a80cbfa328722f5a1',\n);\n\n$response = $sdk->refunds->create(\n refundRequestBody: $refundRequestBody,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->refund !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Refunds.CreateAsync(\n refundRequestBody: new RefundRequestBody() {\n Async = false,\n Transaction = \"915d94940ea54c3a80cbfa328722f5a1\",\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.RefundRequestBody;\nimport com.goshippo.shippo_sdk.models.operations.CreateRefundResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateRefundResponse res = sdk.refunds().create()\n .shippoApiVersion(\"2018-02-08\")\n .refundRequestBody(RefundRequestBody.builder()\n .transaction(\"915d94940ea54c3a80cbfa328722f5a1\")\n .async(false)\n .build())\n .call();\n\n if (res.refund().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/refunds/": { "get": { "description": "Returns a list all refund objects.", "operationId": "ListRefunds", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/refundPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all refunds", "tags": [ "Refunds" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/refunds/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.refunds.list(request=operations.ListRefundsRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.refunds.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->refunds->list(\n shippoApiVersion: '2018-02-08'\n);\n\nif ($response->refundPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Refunds.ListAsync(shippoApiVersion: \"2018-02-08\");\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListRefundsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListRefundsResponse res = sdk.refunds().list()\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.refundPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/refunds/{RefundId}": { "get": { "description": "Returns an existing rate using a rate object ID.", "operationId": "GetRefund", "parameters": [ { "description": "Object ID of the refund to update", "in": "path", "name": "RefundId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/refundResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a refund", "tags": [ "Refunds" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/refunds/d7c811cff9e24e4387418876f1ffd371 \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.refunds.get(refund_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.refunds.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->refunds->get(\n refundId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->refund !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Refunds.GetAsync(\n refundId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetRefundResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetRefundResponse res = sdk.refunds().get()\n .refundId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.refund().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/service-groups": { "get": { "description": "Returns a list of service group objects.", "operationId": "ListServiceGroups", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/serviceGroupListResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all service groups", "tags": [ "Service Groups" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/service-groups \\\n -H \"Authorization: ShippoToken \" \\\n -H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.service_groups.list(request=operations.ListServiceGroupsRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.serviceGroups.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ServiceGroups.ListAsync(shippoApiVersion: \"2018-02-08\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->serviceGroups->list(\n shippoApiVersion: '2018-02-08'\n);\n\nif ($response->serviceGroupListResponse !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListServiceGroupsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListServiceGroupsResponse res = sdk.serviceGroups().list()\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.serviceGroupListResponse().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new service group.", "operationId": "CreateServiceGroup", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroupCreateRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/serviceGroupResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new service group", "tags": [ "Service Groups" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X POST https://api.goshippo.com/service-groups \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"name\": \"UPS shipping\",\n \"description\": \"UPS shipping options\",\n \"flat_rate\": \"5\",\n \"flat_rate_currency\": \"USD\",\n \"type\": \"LIVE_RATE\",\n \"rate_adjustment\": 15,\n \"service_levels\": [\n {\n \"account_object_id\": \"80feb1633d4a43c898f0058506cfd82d\",\n \"service_level_token\": \"ups_next_day_air_saver\"\n },\n {\n \"account_object_id\": \"80feb1633d4a43c898f0058506cfd82d\",\n \"service_level_token\": \"ups_ground\"\n }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.service_groups.create(request=components.ServiceGroupCreateRequest(\n description='USPS shipping options',\n flat_rate='5',\n flat_rate_currency='USD',\n free_shipping_threshold_currency='USD',\n free_shipping_threshold_min='5',\n name='USPS Shipping',\n rate_adjustment=15,\n type=components.ServiceGroupTypeEnum.FLAT_RATE,\n service_levels=[\n components.ServiceGroupAccountAndServiceLevel(\n account_object_id='80feb1633d4a43c898f0058506cfd82d',\n service_level_token='ups_next_day_air_saver',\n ),\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.serviceGroups.create({\n description: \"USPS shipping options\",\n flatRate: \"5\",\n flatRateCurrency: \"USD\",\n freeShippingThresholdCurrency: \"USD\",\n freeShippingThresholdMin: \"5\",\n name: \"USPS Shipping\",\n rateAdjustment: 15,\n type: \"FLAT_RATE\",\n serviceLevels: [\n {\n accountObjectId: \"80feb1633d4a43c898f0058506cfd82d\",\n serviceLevelToken: \"ups_next_day_air_saver\",\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ServiceGroups.CreateAsync(\n serviceGroupCreateRequest: new ServiceGroupCreateRequest() {\n Description = \"USPS shipping options\",\n FlatRate = \"5\",\n FlatRateCurrency = \"USD\",\n FreeShippingThresholdCurrency = \"USD\",\n FreeShippingThresholdMin = \"5\",\n Name = \"USPS Shipping\",\n RateAdjustment = 15,\n Type = ServiceGroupTypeEnum.FlatRate,\n ServiceLevels = new List() {\n new ServiceGroupAccountAndServiceLevel() {\n AccountObjectId = \"80feb1633d4a43c898f0058506cfd82d\",\n ServiceLevelToken = \"ups_next_day_air_saver\",\n },\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$serviceGroupCreateRequest = new Components\\ServiceGroupCreateRequest(\n description: 'USPS shipping options',\n flatRate: '5',\n flatRateCurrency: 'USD',\n freeShippingThresholdCurrency: 'USD',\n freeShippingThresholdMin: '5',\n name: 'USPS Shipping',\n rateAdjustment: 15,\n type: Components\\ServiceGroupTypeEnum::FlatRate,\n serviceLevels: [\n new Components\\ServiceGroupAccountAndServiceLevel(\n accountObjectId: '80feb1633d4a43c898f0058506cfd82d',\n serviceLevelToken: 'ups_next_day_air_saver',\n ),\n ],\n);\n\n$response = $sdk->serviceGroups->create(\n serviceGroupCreateRequest: $serviceGroupCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->serviceGroup !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupAccountAndServiceLevel;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupTypeEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateServiceGroupResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateServiceGroupResponse res = sdk.serviceGroups().create()\n .shippoApiVersion(\"2018-02-08\")\n .serviceGroupCreateRequest(ServiceGroupCreateRequest.builder()\n .description(\"USPS shipping options\")\n .name(\"USPS Shipping\")\n .type(ServiceGroupTypeEnum.FLAT_RATE)\n .serviceLevels(List.of(\n ServiceGroupAccountAndServiceLevel.builder()\n .accountObjectId(\"80feb1633d4a43c898f0058506cfd82d\")\n .serviceLevelToken(\"ups_next_day_air_saver\")\n .build()))\n .flatRate(\"5\")\n .flatRateCurrency(\"USD\")\n .freeShippingThresholdCurrency(\"USD\")\n .freeShippingThresholdMin(\"5\")\n .rateAdjustment(15L)\n .build())\n .call();\n\n if (res.serviceGroup().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "put": { "description": "Updates an existing service group object.
The object_id cannot be updated as it is the unique identifier for the object.", "operationId": "UpdateServiceGroup", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroupUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/serviceGroupResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Update an existing service group", "tags": [ "Service Groups" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X PUT https://api.goshippo.com/service-groups \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\" \\\n-d '{\n \"object_id\": \"7552000a5f71473c9378e98fc7322c99\",\n \"name\": \"UPS shipping\",\n \"description\": \"UPS shipping options, updated\",\n \"flat_rate\": \"20\",\n \"flat_rate_currency\": \"USD\",\n \"type\": \"LIVE_RATE\",\n \"rate_adjustment\": 15,\n \"service_levels\": [\n {\n \"account_object_id\": \"80feb1633d4a43c898f0058506cfd82d\",\n \"service_level_token\": \"ups_next_day_air_saver\"\n },\n {\n \"account_object_id\": \"80feb1633d4a43c898f0058506cfd82d\",\n \"service_level_token\": \"ups_ground\"\n }\n ]\n }'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.service_groups.update(request=components.ServiceGroupUpdateRequest(\n description='USPS shipping options',\n flat_rate='5',\n flat_rate_currency='USD',\n free_shipping_threshold_currency='USD',\n free_shipping_threshold_min='5',\n name='USPS Shipping',\n rate_adjustment=15,\n type=components.ServiceGroupTypeEnum.FLAT_RATE,\n object_id='80feb1633d4a43c898f005850',\n is_active=True,\n service_levels=[\n components.ServiceGroupAccountAndServiceLevel(\n account_object_id='80feb1633d4a43c898f0058506cfd82d',\n service_level_token='ups_next_day_air_saver',\n ),\n components.ServiceGroupAccountAndServiceLevel(\n account_object_id='80feb1633d4a43c898f0058506cfd82d',\n service_level_token='ups_next_day_air_saver',\n ),\n components.ServiceGroupAccountAndServiceLevel(\n account_object_id='80feb1633d4a43c898f0058506cfd82d',\n service_level_token='ups_next_day_air_saver',\n ),\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.serviceGroups.update({\n description: \"USPS shipping options\",\n flatRate: \"5\",\n flatRateCurrency: \"USD\",\n freeShippingThresholdCurrency: \"USD\",\n freeShippingThresholdMin: \"5\",\n name: \"USPS Shipping\",\n rateAdjustment: 15,\n type: \"FLAT_RATE\",\n objectId: \"80feb1633d4a43c898f005850\",\n isActive: true,\n serviceLevels: [\n {\n accountObjectId: \"80feb1633d4a43c898f0058506cfd82d\",\n serviceLevelToken: \"ups_next_day_air_saver\",\n },\n {\n accountObjectId: \"80feb1633d4a43c898f0058506cfd82d\",\n serviceLevelToken: \"ups_next_day_air_saver\",\n },\n {\n accountObjectId: \"80feb1633d4a43c898f0058506cfd82d\",\n serviceLevelToken: \"ups_next_day_air_saver\",\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ServiceGroups.UpdateAsync(\n shippoApiVersion: \"2018-02-08\",\n serviceGroupUpdateRequest: new ServiceGroupUpdateRequest() {\n Description = \"USPS shipping options\",\n FlatRate = \"5\",\n FlatRateCurrency = \"USD\",\n FreeShippingThresholdCurrency = \"USD\",\n FreeShippingThresholdMin = \"5\",\n Name = \"USPS Shipping\",\n RateAdjustment = 15,\n Type = ServiceGroupTypeEnum.FlatRate,\n ObjectId = \"80feb1633d4a43c898f005850\",\n IsActive = true,\n ServiceLevels = new List() {\n new ServiceGroupAccountAndServiceLevel() {\n AccountObjectId = \"80feb1633d4a43c898f0058506cfd82d\",\n ServiceLevelToken = \"ups_next_day_air_saver\",\n },\n },\n }\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$serviceGroupUpdateRequest = new Components\\ServiceGroupUpdateRequest(\n description: 'USPS shipping options',\n flatRate: '5',\n flatRateCurrency: 'USD',\n freeShippingThresholdCurrency: 'USD',\n freeShippingThresholdMin: '5',\n name: 'USPS Shipping',\n rateAdjustment: 15,\n type: Components\\ServiceGroupTypeEnum::FlatRate,\n objectId: '80feb1633d4a43c898f005850',\n isActive: true,\n serviceLevels: [\n new Components\\ServiceGroupAccountAndServiceLevel(\n accountObjectId: '80feb1633d4a43c898f0058506cfd82d',\n serviceLevelToken: 'ups_next_day_air_saver',\n ),\n ],\n);\n\n$response = $sdk->serviceGroups->update(\n shippoApiVersion: '2018-02-08',\n serviceGroupUpdateRequest: $serviceGroupUpdateRequest\n\n);\n\nif ($response->serviceGroup !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupAccountAndServiceLevel;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.ServiceGroupUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.UpdateServiceGroupResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateServiceGroupResponse res = sdk.serviceGroups().update()\n .shippoApiVersion(\"2018-02-08\")\n .serviceGroupUpdateRequest(ServiceGroupUpdateRequest.builder()\n .description(\"USPS shipping options\")\n .name(\"USPS Shipping\")\n .type(ServiceGroupTypeEnum.FLAT_RATE)\n .objectId(\"80feb1633d4a43c898f005850\")\n .isActive(true)\n .serviceLevels(List.of(\n ServiceGroupAccountAndServiceLevel.builder()\n .accountObjectId(\"80feb1633d4a43c898f0058506cfd82d\")\n .serviceLevelToken(\"ups_next_day_air_saver\")\n .build(),\n ServiceGroupAccountAndServiceLevel.builder()\n .accountObjectId(\"80feb1633d4a43c898f0058506cfd82d\")\n .serviceLevelToken(\"ups_next_day_air_saver\")\n .build(),\n ServiceGroupAccountAndServiceLevel.builder()\n .accountObjectId(\"80feb1633d4a43c898f0058506cfd82d\")\n .serviceLevelToken(\"ups_next_day_air_saver\")\n .build()))\n .flatRate(\"5\")\n .flatRateCurrency(\"USD\")\n .freeShippingThresholdCurrency(\"USD\")\n .freeShippingThresholdMin(\"5\")\n .rateAdjustment(15L)\n .build())\n .call();\n\n if (res.serviceGroup().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/service-groups/{ServiceGroupId}": { "delete": { "description": "Deletes an existing service group using an object ID.", "operationId": "DeleteServiceGroup", "parameters": [ { "description": "Object ID of the service group", "in": "path", "name": "ServiceGroupId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "204": { "description": "The service group was successfully deleted." }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Delete a service group", "tags": [ "Service Groups" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -x DELETE https://api.goshippo.com/service-groups/80feb1633d4a43c898f0058506cfd82d \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\ns.service_groups.delete(service_group_id='')\n\n# Use the SDK ..." }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n await shippo.serviceGroups.delete(\"\");\n\n\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nawait sdk.ServiceGroups.DeleteAsync(\n serviceGroupId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->serviceGroups->delete(\n serviceGroupId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->statusCode === 200) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.DeleteServiceGroupResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n DeleteServiceGroupResponse res = sdk.serviceGroups().delete()\n .serviceGroupId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n // handle response\n }\n}" } ] } }, "/shipments": { "get": { "description": "Returns a list of all shipment objects.

\nIn order to filter results, you must use the below path parameters. \nA maximum date range of 90 days is permitted. \nProvided dates should be ISO 8601 UTC dates (timezone offsets are currently not supported).

\n\nOptional path parameters:
\n `object_created_gt`- object(s) created greater than a provided date time
\n `object_created_gte` - object(s) created greater than or equal to a provided date time
\n `object_created_lt` - object(s) created less than a provided date time
\n `object_created_lte` - object(s) created less than or equal to a provided date time
\n\n Date format examples:
\n `2017-01-01`
\n `2017-01-01T03:30:30` or `2017-01-01T03:30:30.5`
\n `2017-01-01T03:30:30Z`

\n\n Example URL:
\n `https://api.goshippo.com/shipments/?object_created_gte=2017-01-01T00:00:30&object_created_lt=2017-04-01T00:00:30`", "operationId": "ListShipments", "parameters": [ { "$ref": "#/components/parameters/PageTokenQueryParam" }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ObjectCreatedGtQueryParam" }, { "$ref": "#/components/parameters/ObjectCreatedGteQueryParam" }, { "$ref": "#/components/parameters/ObjectCreatedLtQueryParam" }, { "$ref": "#/components/parameters/ObjectCreatedLteQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/shipmentPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all shipments", "tags": [ "Shipments" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/shipments/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shipments.list(request=operations.ListShipmentsRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shipments.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListShipmentsRequest();\n\n$response = $sdk->shipments->list(\n request: $request\n);\n\nif ($response->shipmentPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListShipmentsRequest req = new ListShipmentsRequest() {};\n\nvar res = await sdk.Shipments.ListAsync(req);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListShipmentsRequest;\nimport com.goshippo.shippo_sdk.models.operations.ListShipmentsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListShipmentsRequest req = ListShipmentsRequest.builder()\n .build();\n\n ListShipmentsResponse res = sdk.shipments().list()\n .request(req)\n .call();\n\n if (res.shipmentPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new shipment object.", "operationId": "CreateShipment", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentCreateRequest" } } }, "description": "Shipment details and contact info." }, "responses": { "201": { "$ref": "#/components/responses/shipmentResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new shipment", "tags": [ "Shipments" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/shipments/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n -H \"Content-Type: application/json\" \\\n -d $'{\n \"address_to\": {\n \"name\": \"Mr Hippo\",\n \"street1\": \"965 Mission St #572\",\n \"city\": \"San Francisco\",\n \"state\": \"CA\",\n \"zip\": \"94103\",\n \"country\": \"US\",\n \"phone\": \"4151234567\",\n \"email\": \"mrhippo@shippo.com\"\n },\n \"address_from\": {\n \"name\": \"Mrs Hippo\",\n \"street1\": \"1092 Indian Summer Ct\",\n \"city\": \"San Jose\",\n \"state\": \"CA\",\n \"zip\": \"95122\",\n \"country\": \"US\",\n \"phone\": \"4159876543\",\n \"email\": \"mrshippo@shippo.com\"\n },\n \"parcels\": [{\n \"length\": \"10\",\n \"width\": \"15\",\n \"height\": \"10\",\n \"distance_unit\": \"in\",\n \"weight\": \"1\",\n \"mass_unit\": \"lb\"\n }],\n \"async\": false\n }'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shipments.create(request=components.ShipmentCreateRequest(\n extra=components.ShipmentExtra(\n accounts_receivable_customer_account=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n appropriation_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n bill_of_lading_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n cod_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n customer_reference=components.CustomerReference(\n ref_sort=1,\n ),\n dealer_order_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n dept_number=components.DepartmentNumber(\n ref_sort=3,\n ),\n fda_product_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n insurance=components.Insurance(\n amount='5.5',\n currency='USD',\n ),\n invoice_number=components.InvoiceNumber(\n ref_sort=2,\n ),\n manifest_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n model_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n part_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n po_number=components.PoNumber(\n ref_sort=2,\n ),\n production_code=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n purchase_request_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n rma_number=components.RmaNumber(\n ref_sort=1,\n ),\n salesperson_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n serial_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n store_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n transaction_reference_number=components.UPSReferenceFields(\n prefix='ABC',\n value='value',\n ref_sort=1,\n ),\n ),\n metadata='Customer ID 123456',\n shipment_date='2021-03-22T12:00:00Z',\n address_from=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n address_return='d799c2679e644279b59fe661ac8fa488',\n address_to=components.AddressCreateRequest(\n name='Shwan Ippotle',\n company='Shippo',\n street1='215 Clayton St.',\n street3='',\n street_no='',\n city='San Francisco',\n state='CA',\n zip='94117',\n country='US',\n phone='+1 555 341 9393',\n email='shippotle@shippo.com',\n is_residential=True,\n metadata='Customer ID 123456',\n validate=True,\n ),\n customs_declaration=components.CustomsDeclarationCreateRequest(\n b13a_filing_option=components.CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY,\n certify=True,\n certify_signer='Shawn Ippotle',\n contents_explanation='T-Shirt purchase',\n duties_payor=components.DutiesPayor(\n account='2323434543',\n type=components.CustomsDeclarationCreateRequestType.THIRD_PARTY,\n address=components.CustomsDeclarationCreateRequestAddress(\n name='Patrick Kavanagh',\n zip='80331',\n country='DE',\n ),\n ),\n exporter_identification=components.CustomsExporterIdentification(\n eori_number='PL123456790ABCDE',\n tax_id=components.CustomsTaxIdentification(\n number='123456789',\n type=components.CustomsTaxIdentificationType.EIN,\n ),\n ),\n invoice='#123123',\n metadata='Order ID #123123',\n address_importer=components.AddressImporter(\n name='Shwan Ippotle',\n company='Shippo',\n street1='Blumenstraße',\n street3='',\n street_no='22',\n city='München',\n state='CA',\n zip='80331',\n country='DE',\n phone='80331',\n email='shippotle@shippo.com',\n is_residential=True,\n ),\n contents_type=components.CustomsDeclarationContentsTypeEnum.MERCHANDISE,\n eel_pfc=components.CustomsDeclarationEelPfcEnum.NOEEI_30_37_A,\n incoterm=components.CustomsDeclarationIncotermEnum.DDP,\n items=[\n components.CustomsItemCreateRequest(\n description='T-Shirt',\n mass_unit=components.WeightUnitEnum.LB,\n metadata='Order ID \"123454\"',\n net_weight='5',\n origin_country='',\n quantity=20,\n sku_code='HM-123',\n hs_code='0901.21',\n value_amount='200',\n value_currency='USD',\n ),\n ],\n non_delivery_option=components.CustomsDeclarationNonDeliveryOptionEnum.RETURN,\n test=True,\n ),\n carrier_accounts=[\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels=[\n '',\n components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n ),\n components.ParcelCreateRequest(\n extra=components.ParcelExtra(\n cod=components.Cod(\n amount='5.5',\n currency='USD',\n payment_method=components.PaymentMethod.CASH,\n ),\n insurance=components.ParcelInsurance(\n amount='5.5',\n content='Laptop',\n currency='USD',\n provider=components.ParcelInsuranceProvider.UPS,\n ),\n ),\n metadata='Customer ID 123456',\n mass_unit=components.WeightUnitEnum.LB,\n weight='1',\n distance_unit=components.DistanceUnitEnum.IN,\n height='1',\n length='1',\n width='1',\n ),\n ],\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shipments.create({\n extra: {\n accountsReceivableCustomerAccount: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n appropriationNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n billOfLadingNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n codNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n customerReference: {\n refSort: 1,\n },\n dealerOrderNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n deptNumber: {\n refSort: 3,\n },\n fdaProductCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n insurance: {\n amount: \"5.5\",\n currency: \"USD\",\n },\n invoiceNumber: {\n refSort: 2,\n },\n manifestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n modelNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n partNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n poNumber: {\n refSort: 2,\n },\n productionCode: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n purchaseRequestNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n rmaNumber: {\n refSort: 1,\n },\n salespersonNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n serialNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n storeNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n transactionReferenceNumber: {\n prefix: \"ABC\",\n value: \"value\",\n refSort: 1,\n },\n },\n metadata: \"Customer ID 123456\",\n shipmentDate: \"2021-03-22T12:00:00Z\",\n addressFrom: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n addressReturn: \"d799c2679e644279b59fe661ac8fa488\",\n addressTo: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"215 Clayton St.\",\n street3: \"\",\n streetNo: \"\",\n city: \"San Francisco\",\n state: \"CA\",\n zip: \"94117\",\n country: \"US\",\n phone: \"+1 555 341 9393\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n metadata: \"Customer ID 123456\",\n validate: true,\n },\n customsDeclaration: {\n b13aFilingOption: \"FILED_ELECTRONICALLY\",\n certify: true,\n certifySigner: \"Shawn Ippotle\",\n contentsExplanation: \"T-Shirt purchase\",\n dutiesPayor: {\n account: \"2323434543\",\n type: \"THIRD_PARTY\",\n address: {\n name: \"Patrick Kavanagh\",\n zip: \"80331\",\n country: \"DE\",\n },\n },\n exporterIdentification: {\n eoriNumber: \"PL123456790ABCDE\",\n taxId: {\n number: \"123456789\",\n type: \"EIN\",\n },\n },\n invoice: \"#123123\",\n metadata: \"Order ID #123123\",\n addressImporter: {\n name: \"Shwan Ippotle\",\n company: \"Shippo\",\n street1: \"Blumenstraße\",\n street3: \"\",\n streetNo: \"22\",\n city: \"München\",\n state: \"CA\",\n zip: \"80331\",\n country: \"DE\",\n phone: \"80331\",\n email: \"shippotle@shippo.com\",\n isResidential: true,\n },\n contentsType: \"MERCHANDISE\",\n eelPfc: \"NOEEI_30_37_a\",\n incoterm: \"DDP\",\n items: [\n {\n description: \"T-Shirt\",\n massUnit: \"lb\",\n metadata: \"Order ID \\\"123454\\\"\",\n netWeight: \"5\",\n originCountry: \"\",\n quantity: 20,\n skuCode: \"HM-123\",\n hsCode: \"0901.21\",\n valueAmount: \"200\",\n valueCurrency: \"USD\",\n },\n ],\n nonDeliveryOption: \"RETURN\",\n test: true,\n },\n carrierAccounts: [\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n ],\n parcels: [\n \"\",\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n },\n {\n extra: {\n cod: {\n amount: \"5.5\",\n currency: \"USD\",\n paymentMethod: \"CASH\",\n },\n insurance: {\n amount: \"5.5\",\n content: \"Laptop\",\n currency: \"USD\",\n provider: \"UPS\",\n },\n },\n metadata: \"Customer ID 123456\",\n massUnit: \"lb\",\n weight: \"1\",\n distanceUnit: \"in\",\n height: \"1\",\n length: \"1\",\n width: \"1\",\n },\n ],\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$shipmentCreateRequest = new Components\\ShipmentCreateRequest(\n extra: new Components\\ShipmentExtra(\n accountsReceivableCustomerAccount: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n appropriationNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n billOfLadingNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n codNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n customerReference: new Components\\CustomerReference(\n refSort: 1,\n ),\n dealerOrderNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n deptNumber: new Components\\DepartmentNumber(\n refSort: 3,\n ),\n fdaProductCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n insurance: new Components\\Insurance(\n amount: '5.5',\n currency: 'USD',\n ),\n invoiceNumber: new Components\\InvoiceNumber(\n refSort: 2,\n ),\n manifestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n modelNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n partNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n poNumber: new Components\\PoNumber(\n refSort: 2,\n ),\n productionCode: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n purchaseRequestNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n rmaNumber: new Components\\RmaNumber(\n refSort: 1,\n ),\n salespersonNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n serialNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n storeNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n transactionReferenceNumber: new Components\\UPSReferenceFields(\n prefix: 'ABC',\n value: 'value',\n refSort: 1,\n ),\n ),\n metadata: 'Customer ID 123456',\n shipmentDate: '2021-03-22T12:00:00Z',\n addressFrom: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n addressReturn: 'd799c2679e644279b59fe661ac8fa488',\n addressTo: new Components\\AddressCreateRequest(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: '215 Clayton St.',\n street3: '',\n streetNo: '',\n city: 'San Francisco',\n state: 'CA',\n zip: '94117',\n country: 'US',\n phone: '+1 555 341 9393',\n email: 'shippotle@shippo.com',\n isResidential: true,\n metadata: 'Customer ID 123456',\n validate: true,\n ),\n customsDeclaration: new Components\\CustomsDeclarationCreateRequest(\n b13aFilingOption: Components\\CustomsDeclarationB13AFilingOptionEnum::FiledElectronically,\n certify: true,\n certifySigner: 'Shawn Ippotle',\n contentsExplanation: 'T-Shirt purchase',\n dutiesPayor: new Components\\DutiesPayor(\n account: '2323434543',\n type: Components\\CustomsDeclarationCreateRequestType::ThirdParty,\n address: new Components\\CustomsDeclarationCreateRequestAddress(\n name: 'Patrick Kavanagh',\n zip: '80331',\n country: 'DE',\n ),\n ),\n exporterIdentification: new Components\\CustomsExporterIdentification(\n eoriNumber: 'PL123456790ABCDE',\n taxId: new Components\\CustomsTaxIdentification(\n number: '123456789',\n type: Components\\CustomsTaxIdentificationType::Ein,\n ),\n ),\n invoice: '#123123',\n metadata: 'Order ID #123123',\n addressImporter: new Components\\AddressImporter(\n name: 'Shwan Ippotle',\n company: 'Shippo',\n street1: 'Blumenstraße',\n street3: '',\n streetNo: '22',\n city: 'München',\n state: 'CA',\n zip: '80331',\n country: 'DE',\n phone: '80331',\n email: 'shippotle@shippo.com',\n isResidential: true,\n ),\n contentsType: Components\\CustomsDeclarationContentsTypeEnum::Merchandise,\n eelPfc: Components\\CustomsDeclarationEelPfcEnum::NOEEI3037A,\n incoterm: Components\\CustomsDeclarationIncotermEnum::Ddp,\n items: [\n new Components\\CustomsItemCreateRequest(\n description: 'T-Shirt',\n massUnit: Components\\WeightUnitEnum::Lb,\n metadata: 'Order ID \"123454\"',\n netWeight: '5',\n originCountry: '',\n quantity: 20,\n skuCode: 'HM-123',\n hsCode: '0901.21',\n valueAmount: '200',\n valueCurrency: 'USD',\n ),\n ],\n nonDeliveryOption: Components\\CustomsDeclarationNonDeliveryOptionEnum::Return,\n test: true,\n ),\n carrierAccounts: [\n '065a4a8c10d24a34ab932163a1b87f52',\n '73f706f4bdb94b54a337563840ce52b0',\n ],\n parcels: [\n new Components\\ParcelCreateRequest(\n extra: new Components\\ParcelExtra(\n cod: new Components\\Cod(\n amount: '5.5',\n currency: 'USD',\n paymentMethod: Components\\PaymentMethod::Cash,\n ),\n insurance: new Components\\ParcelInsurance(\n amount: '5.5',\n content: 'Laptop',\n currency: 'USD',\n provider: Components\\ParcelInsuranceProvider::Ups,\n ),\n ),\n metadata: 'Customer ID 123456',\n massUnit: Components\\WeightUnitEnum::Lb,\n weight: '1',\n distanceUnit: Components\\DistanceUnitEnum::In,\n height: '1',\n length: '1',\n width: '1',\n ),\n ],\n);\n\n$response = $sdk->shipments->create(\n shipmentCreateRequest: $shipmentCreateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->shipment !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing System.Collections.Generic;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Shipments.CreateAsync(\n shipmentCreateRequest: new ShipmentCreateRequest() {\n Extra = new ShipmentExtra() {\n AccountsReceivableCustomerAccount = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n AppropriationNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n BillOfLadingNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n CodNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n CustomerReference = new CustomerReference() {\n RefSort = 1,\n },\n DealerOrderNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n DeptNumber = new DepartmentNumber() {\n RefSort = 3,\n },\n FdaProductCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n Insurance = new Insurance() {\n Amount = \"5.5\",\n Currency = \"USD\",\n },\n InvoiceNumber = new InvoiceNumber() {\n RefSort = 2,\n },\n ManifestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n ModelNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PartNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PoNumber = new PoNumber() {\n RefSort = 2,\n },\n ProductionCode = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n PurchaseRequestNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n RmaNumber = new RmaNumber() {\n RefSort = 1,\n },\n SalespersonNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n SerialNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n StoreNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n TransactionReferenceNumber = new UPSReferenceFields() {\n Prefix = \"ABC\",\n Value = \"value\",\n RefSort = 1,\n },\n },\n Metadata = \"Customer ID 123456\",\n ShipmentDate = \"2021-03-22T12:00:00Z\",\n AddressFrom = AddressFrom.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n AddressReturn = AddressReturn.CreateStr(\n \"d799c2679e644279b59fe661ac8fa488\"\n ),\n AddressTo = AddressTo.CreateAddressCreateRequest(\n new AddressCreateRequest() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"215 Clayton St.\",\n Street3 = \"\",\n StreetNo = \"\",\n City = \"San Francisco\",\n State = \"CA\",\n Zip = \"94117\",\n Country = \"US\",\n Phone = \"+1 555 341 9393\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n Metadata = \"Customer ID 123456\",\n Validate = true,\n }\n ),\n CustomsDeclaration = ShipmentCreateRequestCustomsDeclaration.CreateCustomsDeclarationCreateRequest(\n new CustomsDeclarationCreateRequest() {\n B13aFilingOption = CustomsDeclarationB13AFilingOptionEnum.FiledElectronically,\n Certify = true,\n CertifySigner = \"Shawn Ippotle\",\n ContentsExplanation = \"T-Shirt purchase\",\n DutiesPayor = new DutiesPayor() {\n Account = \"2323434543\",\n Type = CustomsDeclarationCreateRequestType.ThirdParty,\n Address = new CustomsDeclarationCreateRequestAddress() {\n Name = \"Patrick Kavanagh\",\n Zip = \"80331\",\n Country = \"DE\",\n },\n },\n ExporterIdentification = new CustomsExporterIdentification() {\n EoriNumber = \"PL123456790ABCDE\",\n TaxId = new CustomsTaxIdentification() {\n Number = \"123456789\",\n Type = CustomsTaxIdentificationType.Ein,\n },\n },\n Invoice = \"#123123\",\n Metadata = \"Order ID #123123\",\n AddressImporter = new AddressImporter() {\n Name = \"Shwan Ippotle\",\n Company = \"Shippo\",\n Street1 = \"Blumenstraße\",\n Street3 = \"\",\n StreetNo = \"22\",\n City = \"München\",\n State = \"CA\",\n Zip = \"80331\",\n Country = \"DE\",\n Phone = \"80331\",\n Email = \"shippotle@shippo.com\",\n IsResidential = true,\n },\n ContentsType = CustomsDeclarationContentsTypeEnum.Merchandise,\n EelPfc = CustomsDeclarationEelPfcEnum.Noeei3037A,\n Incoterm = CustomsDeclarationIncotermEnum.Ddp,\n Items = new List() {\n new CustomsItemCreateRequest() {\n Description = \"T-Shirt\",\n MassUnit = WeightUnitEnum.Lb,\n Metadata = \"Order ID \\\"123454\\\"\",\n NetWeight = \"5\",\n OriginCountry = \"\",\n Quantity = 20,\n SkuCode = \"HM-123\",\n HsCode = \"0901.21\",\n ValueAmount = \"200\",\n ValueCurrency = \"USD\",\n },\n },\n NonDeliveryOption = CustomsDeclarationNonDeliveryOptionEnum.Return,\n Test = true,\n }\n ),\n CarrierAccounts = new List() {\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\",\n },\n Parcels = new List() {\n Parcels.CreateParcelCreateRequest(\n new ParcelCreateRequest() {\n Extra = new ParcelExtra() {\n Cod = new Cod() {\n Amount = \"5.5\",\n Currency = \"USD\",\n PaymentMethod = PaymentMethod.Cash,\n },\n Insurance = new ParcelInsurance() {\n Amount = \"5.5\",\n Content = \"Laptop\",\n Currency = \"USD\",\n Provider = ParcelInsuranceProvider.Ups,\n },\n },\n Metadata = \"Customer ID 123456\",\n MassUnit = WeightUnitEnum.Lb,\n Weight = \"1\",\n DistanceUnit = DistanceUnitEnum.In,\n Height = \"1\",\n Length = \"1\",\n Width = \"1\",\n }\n ),\n },\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.AddressCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.AddressFrom;\nimport com.goshippo.shippo_sdk.models.components.AddressImporter;\nimport com.goshippo.shippo_sdk.models.components.AddressReturn;\nimport com.goshippo.shippo_sdk.models.components.AddressTo;\nimport com.goshippo.shippo_sdk.models.components.Cod;\nimport com.goshippo.shippo_sdk.models.components.CustomerReference;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationB13AFilingOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationContentsTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestAddress;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationCreateRequestType;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationEelPfcEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationIncotermEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsDeclarationNonDeliveryOptionEnum;\nimport com.goshippo.shippo_sdk.models.components.CustomsExporterIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsItemCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentification;\nimport com.goshippo.shippo_sdk.models.components.CustomsTaxIdentificationType;\nimport com.goshippo.shippo_sdk.models.components.DepartmentNumber;\nimport com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;\nimport com.goshippo.shippo_sdk.models.components.DutiesPayor;\nimport com.goshippo.shippo_sdk.models.components.Insurance;\nimport com.goshippo.shippo_sdk.models.components.InvoiceNumber;\nimport com.goshippo.shippo_sdk.models.components.ParcelCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ParcelExtra;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsurance;\nimport com.goshippo.shippo_sdk.models.components.ParcelInsuranceProvider;\nimport com.goshippo.shippo_sdk.models.components.Parcels;\nimport com.goshippo.shippo_sdk.models.components.PaymentMethod;\nimport com.goshippo.shippo_sdk.models.components.PoNumber;\nimport com.goshippo.shippo_sdk.models.components.RmaNumber;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.ShipmentCreateRequestCustomsDeclaration;\nimport com.goshippo.shippo_sdk.models.components.ShipmentExtra;\nimport com.goshippo.shippo_sdk.models.components.UPSReferenceFields;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateShipmentResponse;\nimport java.lang.Exception;\nimport java.util.List;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateShipmentResponse res = sdk.shipments().create()\n .shippoApiVersion(\"2018-02-08\")\n .shipmentCreateRequest(ShipmentCreateRequest.builder()\n .addressFrom(AddressFrom.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .addressTo(AddressTo.of(AddressCreateRequest.builder()\n .country(\"US\")\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"215 Clayton St.\")\n .street3(\"\")\n .streetNo(\"\")\n .city(\"San Francisco\")\n .state(\"CA\")\n .zip(\"94117\")\n .phone(\"+1 555 341 9393\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .metadata(\"Customer ID 123456\")\n .validate(true)\n .build()))\n .parcels(List.of(\n Parcels.of(\"\"),\n Parcels.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build()),\n Parcels.of(ParcelCreateRequest.builder()\n .massUnit(WeightUnitEnum.LB)\n .weight(\"1\")\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"1\")\n .length(\"1\")\n .width(\"1\")\n .extra(ParcelExtra.builder()\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .insurance(ParcelInsurance.builder()\n .amount(\"5.5\")\n .content(\"Laptop\")\n .currency(\"USD\")\n .provider(ParcelInsuranceProvider.UPS)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .build())))\n .extra(ShipmentExtra.builder()\n .accountsReceivableCustomerAccount(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .appropriationNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .billOfLadingNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .cod(Cod.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .paymentMethod(PaymentMethod.CASH)\n .build())\n .codNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .customerReference(CustomerReference.builder()\n .refSort(1L)\n .build())\n .dealerOrderNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .deptNumber(DepartmentNumber.builder()\n .refSort(3L)\n .build())\n .fdaProductCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .insurance(Insurance.builder()\n .amount(\"5.5\")\n .currency(\"USD\")\n .build())\n .invoiceNumber(InvoiceNumber.builder()\n .refSort(2L)\n .build())\n .manifestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .modelNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .partNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .poNumber(PoNumber.builder()\n .refSort(2L)\n .build())\n .productionCode(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .purchaseRequestNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .rmaNumber(RmaNumber.builder()\n .refSort(1L)\n .build())\n .salespersonNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .serialNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .storeNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .transactionReferenceNumber(UPSReferenceFields.builder()\n .prefix(\"ABC\")\n .value(\"value\")\n .refSort(1L)\n .build())\n .build())\n .metadata(\"Customer ID 123456\")\n .shipmentDate(\"2021-03-22T12:00:00Z\")\n .addressReturn(AddressReturn.of(\"d799c2679e644279b59fe661ac8fa488\"))\n .customsDeclaration(ShipmentCreateRequestCustomsDeclaration.of(CustomsDeclarationCreateRequest.builder()\n .certify(true)\n .certifySigner(\"Shawn Ippotle\")\n .contentsType(CustomsDeclarationContentsTypeEnum.MERCHANDISE)\n .items(List.of(\n CustomsItemCreateRequest.builder()\n .description(\"T-Shirt\")\n .massUnit(WeightUnitEnum.LB)\n .netWeight(\"5\")\n .originCountry(\"\")\n .quantity(20L)\n .valueAmount(\"200\")\n .valueCurrency(\"USD\")\n .metadata(\"Order ID \\\"123454\\\"\")\n .skuCode(\"HM-123\")\n .hsCode(\"0901.21\")\n .build()))\n .nonDeliveryOption(CustomsDeclarationNonDeliveryOptionEnum.RETURN)\n .b13aFilingOption(CustomsDeclarationB13AFilingOptionEnum.FILED_ELECTRONICALLY)\n .contentsExplanation(\"T-Shirt purchase\")\n .dutiesPayor(DutiesPayor.builder()\n .account(\"2323434543\")\n .type(CustomsDeclarationCreateRequestType.THIRD_PARTY)\n .address(CustomsDeclarationCreateRequestAddress.builder()\n .name(\"Patrick Kavanagh\")\n .zip(\"80331\")\n .country(\"DE\")\n .build())\n .build())\n .exporterIdentification(CustomsExporterIdentification.builder()\n .eoriNumber(\"PL123456790ABCDE\")\n .taxId(CustomsTaxIdentification.builder()\n .number(\"123456789\")\n .type(CustomsTaxIdentificationType.EIN)\n .build())\n .build())\n .invoice(\"#123123\")\n .metadata(\"Order ID #123123\")\n .addressImporter(AddressImporter.builder()\n .name(\"Shwan Ippotle\")\n .company(\"Shippo\")\n .street1(\"Blumenstraße\")\n .street3(\"\")\n .streetNo(\"22\")\n .city(\"München\")\n .state(\"CA\")\n .zip(\"80331\")\n .country(\"DE\")\n .phone(\"80331\")\n .email(\"shippotle@shippo.com\")\n .isResidential(true)\n .build())\n .eelPfc(CustomsDeclarationEelPfcEnum.NOEEI3037_A)\n .incoterm(CustomsDeclarationIncotermEnum.DDP)\n .test(true)\n .build()))\n .carrierAccounts(List.of(\n \"065a4a8c10d24a34ab932163a1b87f52\",\n \"73f706f4bdb94b54a337563840ce52b0\"))\n .build())\n .call();\n\n if (res.shipment().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/shipments/{ShipmentId}": { "get": { "description": "Returns an existing shipment using an object ID", "operationId": "GetShipment", "parameters": [ { "description": "Object ID of the shipment to update", "in": "path", "name": "ShipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/shipmentResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a shipment", "tags": [ "Shipments" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/shipments/7c47d12aa95a4cbb9d90c167cca7bea7 \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shipments.get(shipment_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shipments.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->shipments->get(\n shipmentId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->shipment !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Shipments.GetAsync(\n shipmentId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetShipmentResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetShipmentResponse res = sdk.shipments().get()\n .shipmentId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.shipment().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/shipments/{ShipmentId}/rates": { "get": { "description": "Returns a paginated list of rates associated with a shipment", "operationId": "ListShipmentRates", "parameters": [ { "description": "Object ID of the shipment to update", "in": "path", "name": "ShipmentId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/ratePaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve shipment rates", "tags": [ "Rates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/shipments/5e40ead7cffe4cc1ad45108696162e42/rates/USD \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates.list_shipment_rates(shipment_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.rates.listShipmentRates(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListShipmentRatesRequest(\n shipmentId: '',\n);\n\n$response = $sdk->rates->listShipmentRates(\n request: $request\n);\n\nif ($response->ratePaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListShipmentRatesRequest req = new ListShipmentRatesRequest() {\n ShipmentId = \"\",\n};\n\nvar res = await sdk.Rates.ListShipmentRatesAsync(req);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListShipmentRatesResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListShipmentRatesResponse res = sdk.rates().listShipmentRates()\n .shipmentId(\"\")\n .page(1L)\n .results(25L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.ratePaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ], "x-speakeasy-name-override": "listShipmentRates" } }, "/shipments/{ShipmentId}/rates/{CurrencyCode}": { "get": { "description": "Returns all available shipping rates for a shipment object.\n\nWhen you create a new valid shipment object, Shippo automatically calculates all available rates. Depending on your shipment data, there may be none, one or multiple rates.\n\nBy default, the calculated rates will return the price in two currencies under the `amount` and `amount_local` keys, respectively. The `amount` key will contain the price of a rate expressed in the currency that is used in the country from where the parcel originates, and the `amount_local` key will contain the price expressed in the currency that is used in the country the parcel is shipped to. You can request rates with prices expressed in a different currency by adding the currency code to the end of the resource URL. The full list of supported currencies along with their codes can be viewed on open exchange rates.\n\nNote: re-requesting the rates with a different currency code will re-queue the shipment (i.e. set the Shipment's `status` to `QUEUED`) and the converted currency rates will only be available when the Shipment's `status` is set to `SUCCESS`.", "operationId": "ListShipmentRatesByCurrencyCode", "parameters": [ { "description": "Object ID of the shipment to update", "in": "path", "name": "ShipmentId", "required": true, "schema": { "type": "string" } }, { "description": "ISO currency code for the rates", "in": "path", "name": "CurrencyCode", "required": true, "schema": { "type": "string", "default": "USD" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/ratePaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve shipment rates in currency", "tags": [ "Rates" ], "x-speakeasy-name-override": "listShipmentRatesByCurrencyCode", "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.rates.list_shipment_rates_by_currency_code(request=operations.ListShipmentRatesByCurrencyCodeRequest(\n shipment_id='',\n currency_code='USD',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.rates.listShipmentRatesByCurrencyCode({\n shipmentId: \"\",\n currencyCode: \"USD\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListShipmentRatesByCurrencyCodeRequest req = new ListShipmentRatesByCurrencyCodeRequest() {\n ShipmentId = \"\",\n CurrencyCode = \"USD\",\n};\n\nvar res = await sdk.Rates.ListShipmentRatesByCurrencyCodeAsync(req);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListShipmentRatesByCurrencyCodeRequest(\n shipmentId: '',\n currencyCode: 'USD',\n);\n\n$response = $sdk->rates->listShipmentRatesByCurrencyCode(\n request: $request\n);\n\nif ($response->ratePaginatedList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListShipmentRatesByCurrencyCodeRequest;\nimport com.goshippo.shippo_sdk.models.operations.ListShipmentRatesByCurrencyCodeResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListShipmentRatesByCurrencyCodeRequest req = ListShipmentRatesByCurrencyCodeRequest.builder()\n .shipmentId(\"\")\n .currencyCode(\"USD\")\n .build();\n\n ListShipmentRatesByCurrencyCodeResponse res = sdk.rates().listShipmentRatesByCurrencyCode()\n .request(req)\n .call();\n\n if (res.ratePaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/tracks": { "post": { "description": "Registers a webhook that will send HTTP notifications to you when the status of your tracked package changes. For more details on creating a webhook, see our guides on Webhooks and Tracking.", "operationId": "CreateTrack", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TracksRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/trackResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Register a tracking webhook", "tags": [ "Tracking Status" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/tracks/ \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-d carrier=\"usps\" \\\n-d tracking_number=\"9205590164917312751089\" \\\n-d metadata=\"Order 000123\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.tracking_status.create(request=components.TracksRequest(\n carrier='usps',\n metadata='Order 000123',\n tracking_number='9205590164917312751089',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.trackingStatus.create({\n carrier: \"usps\",\n metadata: \"Order 000123\",\n trackingNumber: \"9205590164917312751089\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.TrackingStatus.CreateAsync(\n tracksRequest: new TracksRequest() {\n Carrier = \"usps\",\n Metadata = \"Order 000123\",\n TrackingNumber = \"9205590164917312751089\",\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$tracksRequest = new Components\\TracksRequest(\n carrier: 'usps',\n metadata: 'Order 000123',\n trackingNumber: '9205590164917312751089',\n);\n\n$response = $sdk->trackingStatus->create(\n tracksRequest: $tracksRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->track !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.TracksRequest;\nimport com.goshippo.shippo_sdk.models.operations.CreateTrackResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateTrackResponse res = sdk.trackingStatus().create()\n .shippoApiVersion(\"2018-02-08\")\n .tracksRequest(TracksRequest.builder()\n .carrier(\"usps\")\n .trackingNumber(\"9205590164917312751089\")\n .metadata(\"Order 000123\")\n .build())\n .call();\n\n if (res.track().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/tracks/{Carrier}/{TrackingNumber}": { "get": { "description": "Returns the tracking status of a shipment using a carrier name and a tracking number.", "operationId": "GetTrack", "parameters": [ { "description": "Tracking number", "in": "path", "name": "TrackingNumber", "required": true, "schema": { "type": "string" } }, { "description": "Name of the carrier", "in": "path", "name": "Carrier", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/trackResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Get a tracking status", "tags": [ "Tracking Status" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/tracks/usps/9205590164917312751089 \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.tracking_status.get(tracking_number='', carrier='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.trackingStatus.get(\"\", \"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.TrackingStatus.GetAsync(\n trackingNumber: \"\",\n carrier: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->trackingStatus->get(\n trackingNumber: '',\n carrier: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->track !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetTrackResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetTrackResponse res = sdk.trackingStatus().get()\n .trackingNumber(\"\")\n .carrier(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.track().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/transactions": { "get": { "description": "Returns a list of all transaction objects.", "operationId": "ListTransactions", "parameters": [ { "description": "Filter by rate ID", "in": "query", "name": "rate", "schema": { "type": "string" } }, { "description": "Filter by object status", "in": "query", "name": "object_status", "schema": { "$ref": "#/components/schemas/TransactionStatusEnum" } }, { "description": "Filter by tracking status", "in": "query", "name": "tracking_status", "schema": { "$ref": "#/components/schemas/TrackingStatusEnum" } }, { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/transactionPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all shipping labels", "tags": [ "Transactions" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/transactions/ \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components, operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.transactions.list(request=operations.ListTransactionsRequest(\n object_status=components.TransactionStatusEnum.SUCCESS,\n tracking_status=components.TrackingStatusEnum.DELIVERED,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.transactions.list({\n objectStatus: \"SUCCESS\",\n trackingStatus: \"DELIVERED\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\nuse Shippo\\API\\Models\\Operations;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Operations\\ListTransactionsRequest(\n objectStatus: Components\\TransactionStatusEnum::Success,\n trackingStatus: Components\\TrackingStatusEnum::Delivered,\n);\n\n$response = $sdk->transactions->list(\n request: $request\n);\n\nif ($response->transactionPaginatedList !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\nusing Shippo.Models.Requests;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nListTransactionsRequest req = new ListTransactionsRequest() {\n ObjectStatus = TransactionStatusEnum.Success,\n TrackingStatus = TrackingStatusEnum.Delivered,\n};\n\nvar res = await sdk.Transactions.ListAsync(req);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.TrackingStatusEnum;\nimport com.goshippo.shippo_sdk.models.components.TransactionStatusEnum;\nimport com.goshippo.shippo_sdk.models.operations.ListTransactionsRequest;\nimport com.goshippo.shippo_sdk.models.operations.ListTransactionsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListTransactionsRequest req = ListTransactionsRequest.builder()\n .objectStatus(TransactionStatusEnum.SUCCESS)\n .trackingStatus(TrackingStatusEnum.DELIVERED)\n .build();\n\n ListTransactionsResponse res = sdk.transactions().list()\n .request(req)\n .call();\n\n if (res.transactionPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new transaction object and purchases the shipping label using a rate object that has previously been created.
OR
Creates a new transaction object and purchases the shipping label instantly using shipment details, an existing carrier account, and an existing service level token.", "operationId": "CreateTransaction", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "oneOf": [ { "$ref": "#/components/schemas/TransactionCreateRequest" }, { "$ref": "#/components/schemas/InstantTransactionCreateRequest" } ] } } }, "description": "Examples.", "x-examples": { "application/json": { "instant-transaction-example": { "summary": "Create an instant transaction", "value": { "async": true, "carrier_account": "b741b99f95e841639b54272834bc478c", "label_file_type": "PDF", "metadata": "Order ID", "servicelevel_token": "usps_priority", "shipment": { "address_from": { "city": "San Francisco", "company": "Shippo", "country": "US", "email": "shippotle@shippo.com", "is_residential": true, "metadata": "Customer ID 123456", "name": "Shwan Ippotle", "phone": "+1 555 341 9393", "state": "CA", "street1": "215 Clayton St.", "street2": "215 Clayton St.", "validate": true, "zip": 94117 }, "address_return": { "city": "San Francisco", "company": "Shippo", "country": "US", "email": "shippotle@shippo.com", "is_residential": true, "metadata": "Customer ID 123456", "name": "Shwan Ippotle", "phone": "+1 555 341 9393", "state": "CA", "street1": "215 Clayton St.", "street2": "215 Clayton St.", "validate": true, "zip": 94117 }, "address_to": { "city": "San Francisco", "company": "Shippo", "country": "US", "email": "shippotle@shippo.com", "is_residential": true, "metadata": "Customer ID 123456", "name": "Shwan Ippotle", "phone": "+1 555 341 9393", "state": "CA", "street1": "215 Clayton St.", "street2": "215 Clayton St.", "validate": true, "zip": 94117 }, "parcels": [ { "distance_unit": "in", "height": 1, "length": 1, "mass_unit": "lb", "template": "USPS_LargeFlatRateBox", "weight": 1, "width": 1 } ] } } }, "rate-transaction-example": { "summary": "Create a rate transaction", "value": { "async": false, "label_file_type": "PDF", "metadata": "Order ID", "rate": "ec9f0d3adc9441449c85d315f0997fd5" } } } } }, "responses": { "201": { "$ref": "#/components/responses/transactionCreateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a shipping label", "tags": [ "Transactions" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl --location --request POST 'https://api.goshippo.com/transactions' \\\n--header 'Authorization: ShippoToken {{token}}' \\\n--header 'Content-Type: application/json' \\\n--header 'SHIPPO-API-VERSION: 2018-02-08' \\\n--data-raw '{\n \"rate\": \"a5c9d1bec93149f5bedc3a9374b50970\",\n \"async\": false,\n \"label_file_type\": \"PDF\"\n}'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.transactions.create(request=components.TransactionCreateRequest(\n async_=False,\n label_file_type=components.LabelFileTypeEnum.PDF_4X6,\n metadata='Order ID #12345',\n rate='ec9f0d3adc9441449c85d315f0997fd5',\n order='adcfdddf8ec64b84ad22772bce3ea37a',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.transactions.create({\n async: false,\n labelFileType: \"PDF_4x6\",\n metadata: \"Order ID #12345\",\n rate: \"ec9f0d3adc9441449c85d315f0997fd5\",\n order: \"adcfdddf8ec64b84ad22772bce3ea37a\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->transactions->create(\n requestBody: new Components\\TransactionCreateRequest(\n async: false,\n labelFileType: Components\\LabelFileTypeEnum::PDF4x6,\n metadata: 'Order ID #12345',\n rate: 'ec9f0d3adc9441449c85d315f0997fd5',\n order: 'adcfdddf8ec64b84ad22772bce3ea37a',\n ),\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->transaction !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Transactions.CreateAsync(\n requestBody: CreateTransactionRequestBody.CreateTransactionCreateRequest(\n new TransactionCreateRequest() {\n Async = false,\n LabelFileType = LabelFileTypeEnum.Pdf4x6,\n Metadata = \"Order ID #12345\",\n Rate = \"ec9f0d3adc9441449c85d315f0997fd5\",\n Order = \"adcfdddf8ec64b84ad22772bce3ea37a\",\n }\n ),\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.LabelFileTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.TransactionCreateRequest;\nimport com.goshippo.shippo_sdk.models.operations.CreateTransactionRequestBody;\nimport com.goshippo.shippo_sdk.models.operations.CreateTransactionResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateTransactionResponse res = sdk.transactions().create()\n .shippoApiVersion(\"2018-02-08\")\n .requestBody(CreateTransactionRequestBody.of(TransactionCreateRequest.builder()\n .rate(\"ec9f0d3adc9441449c85d315f0997fd5\")\n .async(false)\n .labelFileType(LabelFileTypeEnum.PDF4X6)\n .metadata(\"Order ID #12345\")\n .order(\"adcfdddf8ec64b84ad22772bce3ea37a\")\n .build()))\n .call();\n\n if (res.transaction().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/transactions/{TransactionId}": { "get": { "description": "Returns an existing transaction using an object ID.", "operationId": "GetTransaction", "parameters": [ { "description": "Object ID of the transaction to update", "in": "path", "name": "TransactionId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/transactionResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a shipping label", "tags": [ "Transactions" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/transactions/70ae8117ee1749e393f249d5b77c45e0 \\\n -H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.transactions.get(transaction_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.transactions.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->transactions->get(\n transactionId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->transaction !== null) {\n // handle response\n}" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Transactions.GetAsync(\n transactionId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetTransactionResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetTransactionResponse res = sdk.transactions().get()\n .transactionId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.transaction().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/user-parcel-templates": { "get": { "description": "Returns a list all of all user parcel template objects.", "operationId": "ListUserParcelTemplates", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/userParcelTemplateListResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all user parcel templates", "tags": [ "User Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/user-parcel-templates \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import operations\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.user_parcel_templates.list(request=operations.ListUserParcelTemplatesRequest())\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.userParcelTemplates.list({});\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.UserParcelTemplates.ListAsync(shippoApiVersion: \"2018-02-08\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->userParcelTemplates->list(\n shippoApiVersion: '2018-02-08'\n);\n\nif ($response->userParcelTemplateList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListUserParcelTemplatesResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListUserParcelTemplatesResponse res = sdk.userParcelTemplates().list()\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.userParcelTemplateList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new user parcel template.
You can choose to create a\nparcel template using a preset carrier template as a starting point, or\nyou can create an entirely custom one. To use a preset carrier template,\npass in a unique template token from this list\nplus the weight fields (**weight** and **weight_unit**). Otherwise, omit\nthe template field and pass the other fields, for the weight, length, height,\nand depth, as well as their units.\"", "operationId": "CreateUserParcelTemplate", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserParcelTemplateCreateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/userParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a new user parcel template", "tags": [ "User Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X POST https://api.goshippo.com/user-parcel-templates \\\n -H \"Authorization: ShippoToken \" \\\n -H \"Content-Type: application/json\"\n -d '{\n \"name\": \"My Custom Template\",\n \"length\": \"10\",\n \"width\": \"8\",\n \"height\": \"6\",\n \"distance_unit\": \"in\",\n \"weight\": \"12\",\n \"weight_unit\": \"lb\"\n }'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.user_parcel_templates.create(request=components.UserParcelTemplateWithCarrierTemplateCreateRequest(\n weight='12',\n weight_unit=components.WeightUnitEnum.LB,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.userParcelTemplates.create({\n weight: \"12\",\n weightUnit: \"lb\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.UserParcelTemplates.CreateAsync(\n userParcelTemplateCreateRequest: UserParcelTemplateCreateRequest.CreateUserParcelTemplateWithCarrierTemplateCreateRequest(\n new UserParcelTemplateWithCarrierTemplateCreateRequest() {\n Weight = \"12\",\n WeightUnit = WeightUnitEnum.Lb,\n }\n ),\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->userParcelTemplates->create(\n userParcelTemplateCreateRequest: new Components\\UserParcelTemplateWithCarrierTemplateCreateRequest(\n weight: '12',\n weightUnit: Components\\WeightUnitEnum::Lb,\n ),\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->userParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.UserParcelTemplateCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.UserParcelTemplateWithCarrierTemplateCreateRequest;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.CreateUserParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateUserParcelTemplateResponse res = sdk.userParcelTemplates().create()\n .shippoApiVersion(\"2018-02-08\")\n .userParcelTemplateCreateRequest(UserParcelTemplateCreateRequest.of(UserParcelTemplateWithCarrierTemplateCreateRequest.builder()\n .weight(\"12\")\n .weightUnit(WeightUnitEnum.LB)\n .build()))\n .call();\n\n if (res.userParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/user-parcel-templates/{UserParcelTemplateObjectId}": { "delete": { "description": "Deletes a user parcel template using an object ID.", "operationId": "DeleteUserParcelTemplate", "parameters": [ { "description": "Object ID of the user parcel template", "in": "path", "name": "UserParcelTemplateObjectId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "204": { "description": "The user parcel template was successfully deleted." }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Delete a user parcel template", "tags": [ "User Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl -X DELETE https://api.goshippo.com/user-parcel-templates/{UserParcelTemplateObjectId} \\\n -H \"Authorization: ShippoToken \"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\ns.user_parcel_templates.delete(user_parcel_template_object_id='')\n\n# Use the SDK ..." }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n await shippo.userParcelTemplates.delete(\"\");\n\n\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nawait sdk.UserParcelTemplates.DeleteAsync(\n userParcelTemplateObjectId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->userParcelTemplates->delete(\n userParcelTemplateObjectId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->statusCode === 200) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.DeleteUserParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n DeleteUserParcelTemplateResponse res = sdk.userParcelTemplates().delete()\n .userParcelTemplateObjectId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n // handle response\n }\n}" } ] }, "get": { "description": "Returns the parcel template information for a specific user parcel\ntemplate, identified by the object ID.", "operationId": "GetUserParcelTemplate", "parameters": [ { "description": "Object ID of the user parcel template", "in": "path", "name": "UserParcelTemplateObjectId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/userParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieves a user parcel template", "tags": [ "User Parcel Templates" ], "x-codeSamples": [ { "label": "CLI", "lang": "cURL", "source": "curl /user-parcel-templates/{UserParcelTemplateToken} \\\n -H \"Authorization: ShippoToken \" \\\n -H \"Content-Type: application/json\"" }, { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.user_parcel_templates.get(user_parcel_template_object_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.userParcelTemplates.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.UserParcelTemplates.GetAsync(\n userParcelTemplateObjectId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->userParcelTemplates->get(\n userParcelTemplateObjectId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->userParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetUserParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetUserParcelTemplateResponse res = sdk.userParcelTemplates().get()\n .userParcelTemplateObjectId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.userParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "put": { "description": "Updates an existing user parcel template.", "operationId": "UpdateUserParcelTemplate", "parameters": [ { "description": "Object ID of the user parcel template", "in": "path", "name": "UserParcelTemplateObjectId", "required": true, "schema": { "type": "string" } }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserParcelTemplateUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/userParcelTemplateResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Update an existing user parcel template", "tags": [ "User Parcel Templates" ], "x-codeSamples": [ { "label": "cURL", "lang": "cURL", "source": "curl https://api.goshippo.com/user-parcel-templates/b958d3690bb04bb8b2986724872750f5 \\\n-H \"Authorization: ShippoToken shippo_test_3a47d23c032ca626fce863c48d0f93d63a394396\" \\\n-H \"Content-Type: application/json\"\n -d '{\n \"name\": \"My Custom Template\",\n \"length\": \"10\",\n \"width\": \"8\",\n \"height\": \"6\",\n \"distance_unit\": \"in\",\n \"weight\": \"12\",\n \"weight_unit\": \"lb\"\n }'" }, { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.user_parcel_templates.update(user_parcel_template_object_id='', user_parcel_template_update_request=components.UserParcelTemplateUpdateRequest(\n distance_unit=components.DistanceUnitEnum.IN,\n height='6',\n length='10',\n name='My Custom Template',\n weight='12',\n weight_unit=components.WeightUnitEnum.LB,\n width='8',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.userParcelTemplates.update(\"\", {\n distanceUnit: \"in\",\n height: \"6\",\n length: \"10\",\n name: \"My Custom Template\",\n weight: \"12\",\n weightUnit: \"lb\",\n width: \"8\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.UserParcelTemplates.UpdateAsync(\n userParcelTemplateObjectId: \"\",\n shippoApiVersion: \"2018-02-08\",\n userParcelTemplateUpdateRequest: new UserParcelTemplateUpdateRequest() {\n DistanceUnit = DistanceUnitEnum.In,\n Height = \"6\",\n Length = \"10\",\n Name = \"My Custom Template\",\n Weight = \"12\",\n WeightUnit = WeightUnitEnum.Lb,\n Width = \"8\",\n }\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$userParcelTemplateUpdateRequest = new Components\\UserParcelTemplateUpdateRequest(\n distanceUnit: Components\\DistanceUnitEnum::In,\n height: '6',\n length: '10',\n name: 'My Custom Template',\n weight: '12',\n weightUnit: Components\\WeightUnitEnum::Lb,\n width: '8',\n);\n\n$response = $sdk->userParcelTemplates->update(\n userParcelTemplateObjectId: '',\n shippoApiVersion: '2018-02-08',\n userParcelTemplateUpdateRequest: $userParcelTemplateUpdateRequest\n\n);\n\nif ($response->userParcelTemplate !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.DistanceUnitEnum;\nimport com.goshippo.shippo_sdk.models.components.UserParcelTemplateUpdateRequest;\nimport com.goshippo.shippo_sdk.models.components.WeightUnitEnum;\nimport com.goshippo.shippo_sdk.models.operations.UpdateUserParcelTemplateResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateUserParcelTemplateResponse res = sdk.userParcelTemplates().update()\n .userParcelTemplateObjectId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .userParcelTemplateUpdateRequest(UserParcelTemplateUpdateRequest.builder()\n .distanceUnit(DistanceUnitEnum.IN)\n .height(\"6\")\n .length(\"10\")\n .name(\"My Custom Template\")\n .width(\"8\")\n .weight(\"12\")\n .weightUnit(WeightUnitEnum.LB)\n .build())\n .call();\n\n if (res.userParcelTemplate().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/shippo-accounts": { "get": { "description": "Returns a list of Shippo Managed Accounts objects.", "operationId": "ListShippoAccounts", "parameters": [ { "$ref": "#/components/parameters/PageNumberQueryParam" }, { "$ref": "#/components/parameters/ResultsPerPageQueryParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/shippoAccountPaginatedResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "List all Shippo Accounts", "tags": [ "Shippo Accounts" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shippo_accounts.list()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shippoAccounts.list();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ShippoAccounts.ListAsync(\n page: 1,\n results: 25,\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->shippoAccounts->list(\n page: 1,\n results: 25,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->shippoAccountPaginatedList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListShippoAccountsResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListShippoAccountsResponse res = sdk.shippoAccounts().list()\n .page(1L)\n .results(25L)\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.shippoAccountPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "post": { "description": "Creates a new Shippo Managed Account.", "operationId": "CreateShippoAccount", "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippoAccountUpdateRequest" } } } }, "responses": { "201": { "$ref": "#/components/responses/shippoAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Create a Shippo Account", "tags": [ "Shippo Accounts" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shippo_accounts.create(request=components.ShippoAccountUpdateRequest(\n email='hippo@shippo.com',\n first_name='Shippo',\n last_name='Meister',\n company_name='Acme',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shippoAccounts.create({\n email: \"hippo@shippo.com\",\n firstName: \"Shippo\",\n lastName: \"Meister\",\n companyName: \"Acme\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ShippoAccounts.CreateAsync(\n shippoAccountUpdateRequest: new ShippoAccountUpdateRequest() {\n Email = \"hippo@shippo.com\",\n FirstName = \"Shippo\",\n LastName = \"Meister\",\n CompanyName = \"Acme\",\n },\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$shippoAccountUpdateRequest = new Components\\ShippoAccountUpdateRequest(\n email: 'hippo@shippo.com',\n firstName: 'Shippo',\n lastName: 'Meister',\n companyName: 'Acme',\n);\n\n$response = $sdk->shippoAccounts->create(\n shippoAccountUpdateRequest: $shippoAccountUpdateRequest,\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->shippoAccount !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.ShippoAccountUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.CreateShippoAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n CreateShippoAccountResponse res = sdk.shippoAccounts().create()\n .shippoApiVersion(\"2018-02-08\")\n .shippoAccountUpdateRequest(ShippoAccountUpdateRequest.builder()\n .email(\"hippo@shippo.com\")\n .firstName(\"Shippo\")\n .lastName(\"Meister\")\n .companyName(\"Acme\")\n .build())\n .call();\n\n if (res.shippoAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/shippo-accounts/{ShippoAccountId}": { "get": { "description": "Returns a Shippo Managed Account using an object ID.", "operationId": "GetShippoAccount", "parameters": [ { "$ref": "#/components/parameters/ShippoAccountIdPathParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "responses": { "200": { "$ref": "#/components/responses/shippoAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Retrieve a Shippo Account", "tags": [ "Shippo Accounts" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shippo_accounts.get(shippo_account_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shippoAccounts.get(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ShippoAccounts.GetAsync(\n shippoAccountId: \"\",\n shippoApiVersion: \"2018-02-08\"\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->shippoAccounts->get(\n shippoAccountId: '',\n shippoApiVersion: '2018-02-08'\n\n);\n\nif ($response->shippoAccount !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetShippoAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetShippoAccountResponse res = sdk.shippoAccounts().get()\n .shippoAccountId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .call();\n\n if (res.shippoAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "put": { "description": "Updates a Shippo Managed Account using an object ID.", "operationId": "UpdateShippoAccount", "parameters": [ { "$ref": "#/components/parameters/ShippoAccountIdPathParam" }, { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippoAccountUpdateRequest" } } } }, "responses": { "200": { "$ref": "#/components/responses/shippoAccountResponse" }, "400": { "$ref": "#/components/responses/badRequestResponse" } }, "summary": "Update a Shippo Account", "tags": [ "Shippo Accounts" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.shippo_accounts.update(shippo_account_id='', shippo_account_update_request=components.ShippoAccountUpdateRequest(\n email='hippo@shippo.com',\n first_name='Shippo',\n last_name='Meister',\n company_name='Acme',\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.shippoAccounts.update(\"\", {\n email: \"hippo@shippo.com\",\n firstName: \"Shippo\",\n lastName: \"Meister\",\n companyName: \"Acme\",\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.ShippoAccounts.UpdateAsync(\n shippoAccountId: \"\",\n shippoApiVersion: \"2018-02-08\",\n shippoAccountUpdateRequest: new ShippoAccountUpdateRequest() {\n Email = \"hippo@shippo.com\",\n FirstName = \"Shippo\",\n LastName = \"Meister\",\n CompanyName = \"Acme\",\n }\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$shippoAccountUpdateRequest = new Components\\ShippoAccountUpdateRequest(\n email: 'hippo@shippo.com',\n firstName: 'Shippo',\n lastName: 'Meister',\n companyName: 'Acme',\n);\n\n$response = $sdk->shippoAccounts->update(\n shippoAccountId: '',\n shippoApiVersion: '2018-02-08',\n shippoAccountUpdateRequest: $shippoAccountUpdateRequest\n\n);\n\nif ($response->shippoAccount !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.ShippoAccountUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.UpdateShippoAccountResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateShippoAccountResponse res = sdk.shippoAccounts().update()\n .shippoAccountId(\"\")\n .shippoApiVersion(\"2018-02-08\")\n .shippoAccountUpdateRequest(ShippoAccountUpdateRequest.builder()\n .email(\"hippo@shippo.com\")\n .firstName(\"Shippo\")\n .lastName(\"Meister\")\n .companyName(\"Acme\")\n .build())\n .call();\n\n if (res.shippoAccount().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/webhooks": { "post": { "description": "Creates a new webhook to send notifications to a URL when a specific event occurs.", "summary": "Create a new webhook", "operationId": "createWebhook", "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdateRequest" } } } }, "responses": { "201": { "description": "Webhook created successfully", "$ref": "#/components/responses/webhookResponse" } }, "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.webhooks.create_webhook(request=components.WebhookUpdateRequest(\n event=components.WebhookEventTypeEnum.BATCH_CREATED,\n url='https://example.com/shippo-webhook',\n active=True,\n is_test=False,\n))\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.webhooks.createWebhook({\n event: \"batch_created\",\n url: \"https://example.com/shippo-webhook\",\n active: true,\n isTest: false,\n });\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nWebhookUpdateRequest req = new WebhookUpdateRequest() {\n Event = WebhookEventTypeEnum.BatchCreated,\n Url = \"https://example.com/shippo-webhook\",\n Active = true,\n IsTest = false,\n};\n\nvar res = await sdk.Webhooks.CreateWebhookAsync(req);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$request = new Components\\WebhookUpdateRequest(\n event: Components\\WebhookEventTypeEnum::BatchCreated,\n url: 'https://example.com/shippo-webhook',\n active: true,\n isTest: false,\n);\n\n$response = $sdk->webhooks->createWebhook(\n request: $request\n);\n\nif ($response->webhook !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.WebhookEventTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.WebhookUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.CreateWebhookResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n WebhookUpdateRequest req = WebhookUpdateRequest.builder()\n .event(WebhookEventTypeEnum.BATCH_CREATED)\n .url(\"https://example.com/shippo-webhook\")\n .active(true)\n .isTest(false)\n .build();\n\n CreateWebhookResponse res = sdk.webhooks().createWebhook()\n .request(req)\n .call();\n\n if (res.webhook().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "get": { "summary": "List all webhooks", "description": "Returns a list of all webhooks you have created.", "operationId": "listWebhooks", "responses": { "200": { "description": "List of webhooks", "$ref": "#/components/responses/webhookPaginatedResponse" } }, "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.webhooks.list_webhooks()\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.webhooks.listWebhooks();\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Webhooks.ListWebhooksAsync();\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->webhooks->listWebhooks(\n\n);\n\nif ($response->webhookPaginatedList !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.ListWebhooksResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n ListWebhooksResponse res = sdk.webhooks().listWebhooks()\n .call();\n\n if (res.webhookPaginatedList().isPresent()) {\n // handle response\n }\n }\n}" } ] } }, "/webhooks/{webhookId}": { "get": { "summary": "Retrieve a specific webhook", "description": "Returns the details of a specific webhook using the webhook object ID.", "operationId": "getWebhook", "parameters": [ { "name": "webhookId", "description": "Object ID of the webhook to retrieve", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "200": { "description": "Webhook details", "$ref": "#/components/responses/webhookResponse" } }, "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.webhooks.get_webhook(webhook_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.webhooks.getWebhook(\"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Webhooks.GetWebhookAsync(webhookId: \"\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->webhooks->getWebhook(\n webhookId: ''\n);\n\nif ($response->webhook !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.GetWebhookResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n GetWebhookResponse res = sdk.webhooks().getWebhook()\n .webhookId(\"\")\n .call();\n\n if (res.webhook().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "put": { "description": "Updates an existing webhook using the webhook object ID.", "summary": "Update an existing webhook", "operationId": "updateWebhook", "parameters": [ { "name": "webhookId", "description": "Object ID of the webhook to retrieve", "in": "path", "required": true, "schema": { "type": "string" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookUpdateRequest" } } } }, "responses": { "200": { "description": "Webhook updated successfully", "$ref": "#/components/responses/webhookResponse" } }, "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\nfrom shippo.models import components\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\nres = s.webhooks.update_webhook(webhook_update_request=components.WebhookUpdateRequest(\n event=components.WebhookEventTypeEnum.BATCH_CREATED,\n url='https://example.com/shippo-webhook',\n active=True,\n is_test=False,\n), webhook_id='')\n\nif res is not None:\n # handle response\n pass" }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n const result = await shippo.webhooks.updateWebhook({\n event: \"batch_created\",\n url: \"https://example.com/shippo-webhook\",\n active: true,\n isTest: false,\n }, \"\");\n\n // Handle the result\n console.log(result);\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nvar res = await sdk.Webhooks.UpdateWebhookAsync(\n webhookId: \"\",\n webhookUpdateRequest: new WebhookUpdateRequest() {\n Event = WebhookEventTypeEnum.BatchCreated,\n Url = \"https://example.com/shippo-webhook\",\n Active = true,\n IsTest = false,\n }\n);\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\nuse Shippo\\API\\Models\\Components;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n$webhookUpdateRequest = new Components\\WebhookUpdateRequest(\n event: Components\\WebhookEventTypeEnum::BatchCreated,\n url: 'https://example.com/shippo-webhook',\n active: true,\n isTest: false,\n);\n\n$response = $sdk->webhooks->updateWebhook(\n webhookId: '',\n webhookUpdateRequest: $webhookUpdateRequest\n\n);\n\nif ($response->webhook !== null) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.components.WebhookEventTypeEnum;\nimport com.goshippo.shippo_sdk.models.components.WebhookUpdateRequest;\nimport com.goshippo.shippo_sdk.models.operations.UpdateWebhookResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n UpdateWebhookResponse res = sdk.webhooks().updateWebhook()\n .webhookId(\"\")\n .webhookUpdateRequest(WebhookUpdateRequest.builder()\n .event(WebhookEventTypeEnum.BATCH_CREATED)\n .url(\"https://example.com/shippo-webhook\")\n .active(true)\n .isTest(false)\n .build())\n .call();\n\n if (res.webhook().isPresent()) {\n // handle response\n }\n }\n}" } ] }, "delete": { "summary": "Delete a specific webhook", "description": "Deletes a specific webhook using the webhook object ID.", "operationId": "deleteWebhook", "parameters": [ { "name": "webhookId", "description": "Object ID of the webhook to delete", "in": "path", "required": true, "schema": { "type": "string" } } ], "responses": { "204": { "description": "Webhook deleted successfully" } }, "tags": [ "Webhooks" ], "x-codeSamples": [ { "lang": "python", "label": "Python", "source": "import shippo\n\ns = shippo.Shippo(\n api_key_header='ShippoToken ',\n shippo_api_version='2018-02-08',\n)\n\n\ns.webhooks.delete_webhook(webhook_id='')\n\n# Use the SDK ..." }, { "lang": "typescript", "label": "Typescript", "source": "import { Shippo } from \"shippo\";\n\nconst shippo = new Shippo({\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\",\n});\n\nasync function run() {\n await shippo.webhooks.deleteWebhook(\"\");\n\n\n}\n\nrun();" }, { "lang": "csharp", "label": "C#", "source": "using Shippo;\nusing Shippo.Models.Components;\n\nvar sdk = new ShippoSDK(\n apiKeyHeader: \"ShippoToken \",\n shippoApiVersion: \"2018-02-08\"\n);\n\nawait sdk.Webhooks.DeleteWebhookAsync(webhookId: \"\");\n\n// handle response" }, { "lang": "php", "label": "PHP", "source": "declare(strict_types=1);\n\nrequire 'vendor/autoload.php';\n\nuse Shippo\\API;\n\n$sdk = API\\Shippo::builder()\n ->setSecurity(\n 'ShippoToken '\n )\n ->setShippoApiVersion('2018-02-08')\n ->build();\n\n\n\n$response = $sdk->webhooks->deleteWebhook(\n webhookId: ''\n);\n\nif ($response->statusCode === 200) {\n // handle response\n}" }, { "lang": "java", "label": "Java", "source": "package hello.world;\n\nimport com.goshippo.shippo_sdk.Shippo;\nimport com.goshippo.shippo_sdk.models.operations.DeleteWebhookResponse;\nimport java.lang.Exception;\n\npublic class Application {\n\n public static void main(String[] args) throws Exception {\n\n Shippo sdk = Shippo.builder()\n .apiKeyHeader(\"ShippoToken \")\n .shippoApiVersion(\"2018-02-08\")\n .build();\n\n DeleteWebhookResponse res = sdk.webhooks().deleteWebhook()\n .webhookId(\"\")\n .call();\n\n // handle response\n }\n}" } ] } } }, "components": { "parameters": { "PageTokenQueryParam": { "description": "The page token for paginated results", "in": "query", "name": "page_token", "required": false, "schema": { "type": "string" } }, "PageNumberQueryParam": { "description": "The page number you want to select", "in": "query", "name": "page", "schema": { "type": "integer", "format": "int64", "default": 1 } }, "ResultsPerPageQueryParam": { "description": "The number of results to return per page (max 100)", "in": "query", "name": "results", "schema": { "type": "integer", "format": "int64", "maximum": 100, "default": 25 } }, "ResultsPerPageDefault5QueryParam": { "description": "The number of results to return per page (max 100, default 5)", "in": "query", "name": "results", "schema": { "type": "integer", "format": "int64", "maximum": 100, "default": 5 } }, "ShippoApiVersionHeader": { "description": "Optional string used to pick a non-default API version to use. See our API version guide.", "in": "header", "name": "SHIPPO-API-VERSION", "schema": { "type": "string", "example": "2018-02-08" }, "x-speakeasy-globals-hidden": true }, "ObjectCreatedGtQueryParam": { "description": "Object(s) created greater than a provided date and time.", "in": "query", "name": "object_created_gt", "required": false, "schema": { "type": "string" } }, "ObjectCreatedGteQueryParam": { "description": "Object(s) created greater than or equal to a provided date and time.", "in": "query", "name": "object_created_gte", "required": false, "schema": { "type": "string" } }, "ObjectCreatedLtQueryParam": { "description": "Object(s) created lesser than a provided date and time.", "in": "query", "name": "object_created_lt", "required": false, "schema": { "type": "string" } }, "ObjectCreatedLteQueryParam": { "description": "Object(s) created lesser than or equal to a provided date and time.", "in": "query", "name": "object_created_lte", "required": false, "schema": { "type": "string" } }, "ShippoAccountIdPathParam": { "description": "Object ID of the ShippoAccount", "in": "path", "name": "ShippoAccountId", "required": true, "schema": { "type": "string" } } }, "responses": { "carrierParcelTemplateListResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierParcelTemplateList" } } } }, "userParcelTemplateListResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserParcelTemplateList" } } } }, "trackResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, "serviceGroupResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ServiceGroup" } } } }, "serviceGroupListResponse": { "description": "", "content": { "application/json": { "schema": { "items": { "$ref": "#/components/schemas/ServiceGroup" }, "type": "array" } } } }, "defaultParcelTemplateResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DefaultParcelTemplate" } } } }, "transactionPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransactionPaginatedList" } } } }, "invoiceResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Invoice" } } } }, "invoicePaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoicePaginatedList" } } } }, "invoiceItemsPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/InvoiceItemPaginatedList" } } } }, "addressPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AddressPaginatedList" } } } }, "customsDeclarationPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclarationPaginatedList" } } } }, "customsItemPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsItemPaginatedList" } } } }, "manifestPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ManifestPaginatedList" } } } }, "refundPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RefundPaginatedList" } } } }, "orderPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/OrderPaginatedList" } } } }, "parcelPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ParcelPaginatedList" } } } }, "ratePaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RatePaginatedList" } } } }, "shipmentPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShipmentPaginatedList" } } } }, "badRequestResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/BadRequest" } } } }, "carrierAccountResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAccount" } } } }, "carrierAccountPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAccountPaginatedList" } } } }, "liveRatePaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LiveRatePaginatedList" } } } }, "addressResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Address" } } } }, "batchResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Batch" } } } }, "carrierParcelTemplateResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierParcelTemplate" } } } }, "customsDeclarationResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsDeclaration" } } } }, "customsItemResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CustomsItem" } } } }, "manifestResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Manifest" } } } }, "orderResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Order" } } } }, "parcelResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Parcel" } } } }, "pickupResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Pickup" } } } }, "rateResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Rate" } } } }, "refundResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Refund" } } } }, "shipmentResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Shipment" } } } }, "transactionResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "transactionCreateResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Transaction" } } } }, "userParcelTemplateResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UserParcelTemplate" } } } }, "shippoAccountPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippoAccountPaginatedList" } } } }, "shippoAccountResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ShippoAccount" } } } }, "webhookResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Webhook" } } } }, "webhookPaginatedResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPaginatedList" } } } }, "carrierAccountRegistrationStatusResponse": { "description": "", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CarrierAccountRegistrationStatus" } } } } }, "securitySchemes": { "APIKeyHeader": { "in": "header", "name": "Authorization", "type": "apiKey" } }, "schemas": { "PaginatedList": { "properties": { "next": { "example": "baseurl?page=3&results=10", "type": "string" }, "previous": { "example": "baseurl?page=1&results=10", "type": "string" } }, "type": "object" }, "AddressBase": { "description": "Address represents the address as retrieved from the database", "properties": { "name": { "description": "**required for purchase**
\nFirst and Last Name of the addressee\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Either company or name required; No length validation (first 35 chars printed on label) |", "example": "Shwan Ippotle", "type": "string", "maxLength": 100 }, "company": { "example": "Shippo", "type": "string", "maxLength": 100, "description": "Company Name\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 35 characters; Either company or name required |" }, "street1": { "description": "**required for purchase**
\nFirst street line. Usually street number and street name (except for DHL Germany, see street_no).\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |", "example": "215 Clayton St.", "type": "string", "maxLength": 121 }, "street2": { "type": "string", "maxLength": 100, "description": "Second street line.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |" }, "street3": { "type": "string", "maxLength": 100, "example": "", "description": "Third street line.\nOnly accepted for USPS international shipments, UPS domestic and UPS international shipments.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | At least one street line required; Max 35 characters per line |" }, "street_no": { "type": "string", "example": "", "description": "Street number of the addressed building. \nThis field can be included in street1 for all carriers except for DHL Germany." }, "city": { "description": "**required for purchase**
\nName of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates.\nPlease bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state\nor a ZIP code (see below), if known, it will yield more accurate results.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Max 35 characters |", "example": "San Francisco", "type": "string", "maxLength": 100 }, "state": { "description": "**required for purchase for some countries**
\nState/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some\ncountries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers\nonly accept two or three character state abbreviations.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required if country requires state; Max 2 characters for US, CA, PR |", "example": "CA", "type": "string", "maxLength": 100 }, "zip": { "description": "**required for purchase**
\nPostal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more\naccurate Rates.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 10 characters |", "example": "94117", "type": "string", "maxLength": 20 }, "country": { "example": "US", "type": "string", "description": "ISO 3166-1 alpha-2 country codes and country names can be used. For most consistent results, we recommend using country codes like `US` or `DE`.\nIf using country names, please ensure they are spelled correctly and in English. Country names are converted to country codes.\nRefer to this guide for a list of country codes.\nSending a country is always required." }, "phone": { "example": "+1 555 341 9393", "type": "string", "maxLength": 50, "description": "Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This\nincreases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Required; Min 1, max 15 characters |" }, "email": { "example": "shippotle@shippo.com", "type": "string", "maxLength": 254, "description": "E-mail address of the contact person, RFC3696/5321-compliant.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 80 characters |" }, "is_residential": { "example": true, "type": "boolean" }, "metadata": { "example": "Customer ID 123456", "type": "string", "maxLength": 100, "description": "A string of up to 100 characters that can be filled with any additional information you want \nto attach to the object." } }, "type": "object" }, "Address": { "x-tags": [ "Addresses" ], "allOf": [ { "$ref": "#/components/schemas/AddressBase" }, { "properties": { "is_complete": { "example": true, "type": "boolean", "description": "Complete addresses contain all required values.

Incomplete addresses have failed one or multiple \nvalidations.
Incomplete Addresses are eligible for requesting rates but lack at least one required \nvalue for purchasing labels." }, "latitude": { "description": "Latitude of address", "type": [ "number", "string" ] }, "longitude": { "description": "Longitude of address", "type": [ "number", "string" ] }, "object_created": { "example": "2014-07-09T02:19:13.174Z", "format": "date-time", "type": "string", "description": "Date and time of Address creation." }, "object_id": { "example": "d799c2679e644279b59fe661ac8fa488", "type": "string", "description": "Unique identifier of the given Address object. \nThis ID is required to create a Shipment object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the Address object." }, "object_updated": { "example": "2014-07-09T02:19:13.174Z", "format": "date-time", "type": "string", "description": "Date and time of last Address update. Since you cannot update Addresses after they were created, this time \nstamp reflects the time when the Address was changed by Shippo's systems for the last time, e.g., during the \napproximation of one or more values." }, "validation_results": { "$ref": "#/components/schemas/AddressValidationResults" }, "test": { "type": "boolean", "example": false, "description": "Indicates whether the object has been created in test mode." } }, "required": [ "country" ] } ] }, "AddressTo": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Address object of the recipient / buyer. Will be returned expanded by default." }, "AddressFrom": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "Address object of the sender / seller. Will be returned expanded by default." }, "AddressReturn": { "allOf": [ { "$ref": "#/components/schemas/Address" } ], "description": "ID of the Address object where the shipment will be sent back to if it is not delivered \n(Only available for UPS, USPS, and Fedex shipments).
\nIf this field is not set, your shipments will be returned to the address_from." }, "AddressCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/AddressBase" }, { "properties": { "validate": { "description": "Set to true to validate Address object.", "example": true, "type": "boolean" } }, "required": [ "country" ] } ] }, "AddressFromCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" } ], "description": "Address object of the sender / seller. Will be returned expanded by default.." }, "AddressToCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" } ], "description": "Address object of the recipient / buyer. Will be returned expanded by default." }, "AddressCompleteCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/AddressBase" }, { "properties": { "validate": { "example": true, "type": "boolean" } }, "required": [ "name", "street1", "city", "state", "zip", "country" ] } ] }, "AddressPickupCompleteCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/AddressCompleteCreateRequest" } ], "description": "The pickup address, which includes your name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email." }, "AddressPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/AddressTo" }, "type": "array" } } } ] }, "AddressImporter": { "description": "Object that represents the address of the importer", "type": "object", "properties": { "name": { "description": "First and Last Name of the addressee", "example": "Shwan Ippotle", "type": "string" }, "company": { "example": "Shippo", "type": "string", "description": "Company Name" }, "street1": { "description": "First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no).", "example": "Blumenstraße", "type": "string" }, "street2": { "type": "string", "description": "Second street line, 35 character limit." }, "street3": { "type": "string", "example": "", "description": "Third street line, 35 character limit. \nOnly accepted for USPS international shipments, UPS domestic and UPS international shipments." }, "street_no": { "type": "string", "example": "22", "description": "Street number of the addressed building. \nThis field can be included in street1 for all carriers except for DHL Germany." }, "city": { "description": "Name of a city", "example": "München", "type": "string" }, "state": { "description": "**required for purchase for some countries**
\nState/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some \ncountries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers \nonly accept two or three character state abbreviations.", "example": "CA", "type": "string" }, "zip": { "description": "Postal code of an Address.", "example": "80331", "type": "string" }, "country": { "example": "DE", "type": "string", "description": "Example: `US` or `DE`. All accepted values can be found on the \nOfficial ISO Website.\nSending a country is always required." }, "phone": { "example": "80331", "type": "string", "description": "Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This \nincreases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. " }, "email": { "example": "shippotle@shippo.com", "type": "string", "description": "E-mail address of the contact person, RFC3696/5321-compliant." }, "is_residential": { "example": true, "type": "boolean", "description": "Indicates whether the address provided is a residential address or not." } } }, "AddressImporterResponse": { "properties": { "object_id": { "description": "ID of importer address object", "example": "7506ccbb65a34a8a9ac2cc4a89e820d2", "type": "string" } } }, "AddressValidationResults": { "description": "Object that contains information regarding if an address had been validated or not. Also contains any messages \ngenerated during validation. Children keys are is_valid(boolean) and messages(array).", "properties": { "is_valid": { "example": false, "type": "boolean" }, "messages": { "items": { "$ref": "#/components/schemas/AddressValidationResultsMessage" }, "type": "array" } }, "type": "object" }, "AddressValidationResultsMessage": { "properties": { "code": { "type": "string", "example": "Unknown Street", "description": "See Address Validation Codes" }, "source": { "type": "string", "example": "Shippo Address Validator", "description": "See Address Validation Source" }, "text": { "example": "City, State and ZIP Code are valid, but street address is not a match.", "type": "string" }, "type": { "example": "address_warning", "type": "string" } }, "type": "object" }, "AddressValidationResultsMessageCodeEnum": { "type": "string", "enum": [ "verification_error", "unknown_street", "component_mismatch_error", "multiple_match", "sub_premise_number_invalid", "sub_premise_number_missing", "premise_number_invalid", "premise_number_missing", "box_number_invalid", "box_number_missing", "pmb_number_missing", "postal_code_change", "administrative_area_change", "locality_change", "dependent_locality_change", "street_name_change", "street_type_change", "street_directional_change", "sub_premise_type_change", "sub_premise_number_change", "double_dependent_locality_change", "subadministrative_area_change", "subnational_area_change", "po_box_change", "premise_type_change", "house_number_change", "organization_change", "extraneous_information", "usps_door_inaccessible", "administrative_area_partial", "city_partial", "street_partial", "building_partial", "subpremise_partial", "administrative_area_full", "city_full", "thoroughfare_full", "premises_full", "subpremise_full", "geocoded_street", "geocoded_neighborhood", "geocoded_community", "geocoded_state", "geocoded_rooftop", "geocoded_interpolated_rooftop", "invalid_postal_code", "postal_code_not_found", "empty_request", "service_error", "street_detail_missing", "Invalid City/State/Zip", "Default Match", "Unknown Street", "Address Not Found", "Non-Deliverable ZIP4", "Multiple Responses", "Invalid Dual Address", "Invalid State", "Invalid City", "Ambiguous Address" ], "x-speakeasy-include": true }, "AddressValidationResultsMessageSourceEnum": { "type": "string", "enum": [ "Shippo Address Validator", "UPS" ], "x-speakeasy-include": true }, "Alcohol": { "description": "Indicates that a shipment contains Alcohol (Fedex and UPS only).", "properties": { "contains_alcohol": { "type": "boolean", "description": "Mandatory for Fedex and UPS. Specifies that the package contains Alcohol." }, "recipient_type": { "enum": [ "licensee", "consumer" ], "description": "Mandatory for Fedex only. License type of the recipient of the Alcohol Package." } }, "type": "object" }, "AmountAndCurrencyCharged": { "description": "The amount and currency that was charged after possible currency conversion occurred.", "properties": { "amount": { "description": "The money amount", "example": "5.52", "type": "string" }, "currency": { "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\nISO 4217 Standard.", "example": "USD", "type": "string" } }, "type": "object" }, "AmountAndCurrencyInvoiced": { "description": "The amount and currency.", "properties": { "amount": { "description": "The money amount", "example": "5.52", "type": "string" }, "currency": { "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\nISO 4217 Standard.", "example": "USD", "type": "string" } }, "type": "object" }, "ConversionAmount": { "description": "Invoice Item's amount after currency conversion took place.", "properties": { "rate": { "example": "0.89", "type": "string", "description": "Currency conversion rate, relative to USD, that was used to calculate the converted amount." }, "time": { "type": "string", "format": "date-time", "description": "Date and time the currency conversion took place." }, "amount": { "description": "The money amount after currency conversion.", "example": "4.91", "type": "string" }, "currency": { "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\nISO 4217 Standard.", "example": "USD", "type": "string" } }, "type": "object" }, "BatchBase": { "properties": { "default_carrier_account": { "description": "ID of the Carrier Account object to use as the default for all shipments in this Batch. \nThe carrier account can be changed on a per-shipment basis by changing the carrier_account in the \ncorresponding BatchShipment object.", "example": "078870331023437cb917f5187429b093", "type": "string" }, "default_servicelevel_token": { "description": "Token of the service level to use as the default for all shipments in this Batch. \nThe servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the \ncorresponding BatchShipment object. Servicelevel tokens can be found here.", "example": "usps_priority", "type": "string" }, "label_filetype": { "$ref": "#/components/schemas/LabelFileTypeEnum" }, "metadata": { "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object.", "example": "BATCH #1", "maxLength": 100, "type": "string" } }, "required": [ "default_carrier_account", "default_servicelevel_token" ], "type": "object" }, "Batch": { "x-tags": [ "Batches" ], "allOf": [ { "$ref": "#/components/schemas/BatchBase" }, { "properties": { "batch_shipments": { "$ref": "#/components/schemas/BatchShipmentPaginatedList" }, "label_url": { "description": "An array of URLs each pointing to a merged file of 100 labels each", "items": { "type": "string" }, "type": "array" }, "object_created": { "description": "Date and time of Batch creation", "example": "2016-01-04T00:15:44.394Z", "type": "string" }, "object_id": { "description": "Unique identifier of the given Batch object", "example": "5ef63c54f5bf45d3b1f8fb37dcb1c5f4", "type": "string" }, "object_owner": { "description": "Username of the user who created the Batch object.", "example": "shippo@shippo.com", "type": "string" }, "object_results": { "description": "An object containing the following counts:
`creation_succeeded`
`creation_failed`
`purchase_succeeded`
`purchase_failed`", "properties": { "creation_failed": { "example": 3, "format": "int64", "type": "integer" }, "creation_succeeded": { "example": 5, "format": "int64", "type": "integer" }, "purchase_failed": { "example": 0, "format": "int64", "type": "integer" }, "purchase_succeeded": { "example": 0, "format": "int64", "type": "integer" } }, "required": [ "purchase_failed", "purchase_succeeded", "creation_failed", "creation_succeeded" ], "type": "object" }, "object_updated": { "description": "Date and time of last update to the Batch", "example": "2016-01-04T00:48:13.841Z", "type": "string" }, "status": { "description": "Batches that are `VALIDATING` are being created and validated
\n`VALID` batches can be purchased
\n`INVALID` batches cannot be purchased, `INVALID` BatchShipments must be removed
\nBatches that are in the `PURCHASING` state are being purchased
\n`PURCHASED` batches are finished purchasing.", "enum": [ "VALIDATING", "VALID", "INVALID", "PURCHASING", "PURCHASED" ], "example": "VALID", "type": "string" }, "test": { "example": false, "type": "boolean" } }, "required": [ "object_id", "object_owner", "status", "object_created", "object_updated", "batch_shipments", "object_results", "label_url" ] } ] }, "BatchCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/BatchBase" }, { "properties": { "batch_shipments": { "description": "Array of BatchShipment objects. The response keeps the same order as in the request array.", "items": { "$ref": "#/components/schemas/BatchShipmentCreateRequest" }, "type": "array" } }, "required": [ "batch_shipments" ] } ] }, "BatchShipmentBase": { "properties": { "carrier_account": { "description": "Object ID of the carrier account to be used for this shipment (will override batch default)", "example": "a4391cd4ab974f478f55dc08b5c8e3b3", "type": "string" }, "metadata": { "description": "A string of up to 100 characters that can be filled with any additional information you want \nto attach to the object.", "example": "SHIPMENT #1", "maxLength": 100, "type": "string" }, "servicelevel_token": { "description": "A token that sets the shipping method for the batch, overriding the batch default. \nServicelevel tokens can be found in this list \nor at this endpoint.", "example": "fedex_ground", "type": "string" } }, "type": "object" }, "BatchShipment": { "title": "Batch Shipment", "x-tags": [ "Batches" ], "description": "The batch shipment object is a wrapper around a shipment object, which include shipment-specific information\nfor batch processing.\n\nNote: batch shipments can only be created on the batch endpoint, either when creating a batch object or by through\nthe `/batches/{BATCH_OBJECT_ID}/add_shipments` endpoint", "allOf": [ { "$ref": "#/components/schemas/BatchShipmentBase" }, { "properties": { "messages": { "description": "List of Shipment and Transaction error messages.", "type": "array" }, "object_id": { "description": "Object ID of this batch shipment. Can be used in the remove_shipments endpoint.", "example": "e11c95a6788d4ddcaa22f03175838740", "type": "string" }, "shipment": { "description": "Object ID of the shipment object created for this batch shipment.", "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" }, "status": { "description": "`INVALID` batch shipments cannot be purchased and will have to be removed, fixed, and added to the batch again.
\n`VALID` batch shipments can be purchased.
\nBatch shipments with the status `TRANSACTION_FAILED` were not able to be purchased and the error will be displayed on the message field
\n`INCOMPLETE` batch shipments have an issue with the Address and will need to be removed, fixed, and added to the batch again.", "enum": [ "INVALID", "VALID", "INCOMPLETE", "TRANSACTION_FAILED" ], "example": "INVALID", "type": "string" }, "transaction": { "description": "Object ID of the transaction object created for this batch shipment.", "example": "4c33736a67e2450da88b38c42deef6b7", "type": "string" } }, "required": [ "shipment", "object_id", "status" ] } ] }, "BatchShipmentCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/BatchShipmentBase" }, { "properties": { "shipment": { "$ref": "#/components/schemas/ShipmentCreateRequest" } } } ], "required": [ "shipment" ], "type": "object" }, "BatchShipmentPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "description": "Array of BatchShipment objects. \nThe response keeps the same order as in the request array.", "properties": { "results": { "items": { "$ref": "#/components/schemas/BatchShipment" }, "type": "array" } } } ] }, "Billing": { "description": "Specify billing details (UPS, FedEx, and DHL Germany only).", "properties": { "account": { "type": "string", "description": "Account number to be billed. (For DHL Germany, leave this field blank.)" }, "country": { "type": "string", "format": "iso-3166", "description": "Country iso2 code of account number to be billed (required for UPS third party billing only)." }, "participation_code": { "type": "string", "description": "2 digit code used to override your default participation code associated with your DHL Germany account." }, "type": { "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY", "THIRD_PARTY_CONSIGNEE", "COLLECT" ], "description": "Party to be billed. (Leave blank for DHL Germany.)" }, "zip": { "type": "string", "description": "ZIP code of account number to be billed (required for UPS if there is a zip on the billing account)." } }, "type": "object" }, "COD": { "description": "Specify collection on delivery details (UPS only).", "properties": { "amount": { "description": "Amount to be collected.", "example": "5.5", "type": "string" }, "currency": { "description": "Currency for the amount to be collected. Currently only USD is supported for UPS.", "example": "USD", "type": "string" }, "payment_method": { "description": "Secured funds include money orders, certified cheques and others (see \nUPS for details). \nIf no payment_method inputted the value defaults to \"ANY\".)", "enum": [ "SECURED_FUNDS", "CASH", "ANY" ], "example": "CASH", "type": "string" } }, "title": "COD Specify collection on delivery details (UPS only).", "type": "object" }, "CarrierParcelTemplateList": { "properties": { "results": { "items": { "$ref": "#/components/schemas/CarrierParcelTemplate" }, "type": "array" } }, "type": "object" }, "CarrierParcelTemplate": { "x-tags": [ "Carrier Parcel Templates" ], "properties": { "carrier": { "description": "The name of the carrier that provides this parcel template", "example": "FedEx", "type": "string" }, "distance_unit": { "$ref": "#/components/schemas/DistanceUnitEnum" }, "height": { "description": "The height of the package, in units specified by the distance_unit attribute", "example": "1.5", "type": "string" }, "is_variable_dimensions": { "description": "True if the carrier parcel template allows custom dimensions, such as USPS Softpack.", "example": false, "type": "boolean" }, "length": { "description": "The length of the package, in units specified by the distance_unit attribute", "example": "12.375", "type": "string" }, "name": { "description": "The name of the carrier parcel template", "example": "FedEx® Small Box (S1)", "type": "string" }, "token": { "description": "The unique string representation of the carrier parcel template", "example": "FedEx_Box_Small_1", "type": "string" }, "width": { "description": "The width of the package, in units specified by the distance_unit attribute", "example": "10.875", "type": "string" } }, "title": "Carrier Parcel Template", "type": "object" }, "ConnectExistingOwnAccountRequest": { "title": "Account parameters", "properties": { "account_id": { "example": "321123", "type": "string" }, "active": { "type": "boolean" }, "carrier": { "example": "fedex", "type": "string" }, "metadata": { "example": "FEDEX Account", "type": "string" }, "parameters": { "oneOf": [ { "$ref": "#/components/schemas/ConnectExistingOwnAccountParameters" }, { "$ref": "#/components/schemas/FedExConnectExistingOwnAccountParameters" }, { "$ref": "#/components/schemas/UPSConnectExistingOwnAccountParameters" } ] }, "test": { "example": false, "type": "boolean" } }, "required": [ "carrier", "account_id", "parameters" ], "type": "object" }, "CustomerReference": { "description": "Specify the reference field on the label (FedEx and UPS only).", "properties": { "prefix": { "type": "string", "description": "Custom prefix for customer reference field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property." }, "value": { "type": "string", "maxLength": 40, "description": "Optional text to be printed on the shipping label for customer reference. Up to 40 characters. If\nthis is provided, reference_1 will be ignored.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) |" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 1 } }, "type": "object" }, "CustomsDeclarationBase": { "properties": { "aes_itn": { "description": "**required if eel_pfc is `AES_ITN`**
\nAES / ITN reference of the shipment.", "type": "string" }, "b13a_filing_option": { "type": "string" }, "b13a_number": { "description": "**must be provided if and only if b13a_filing_option is provided**
\nRepresents:
the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;
\nthe Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;
\nor the Exemption Number when b13a_filing_option is `NOT_REQUIRED`.", "type": "string" }, "certificate": { "type": "string", "description": "Certificate reference of the shipment." }, "certify": { "example": true, "type": "boolean", "description": "Expresses that the certify_signer has provided all information of this customs declaration truthfully." }, "certify_signer": { "example": "Shawn Ippotle", "type": "string", "description": "Name of the person who created the customs declaration and is responsible for the validity of all \ninformation provided." }, "commercial_invoice": { "type": "boolean" }, "contents_explanation": { "description": "**required if contents_type is `OTHER`**
\nExplanation of the type of goods of the shipment.", "example": "T-Shirt purchase", "type": "string" }, "disclaimer": { "type": "string", "maxLength": 1000, "description": "Disclaimer for the shipment and customs information that have been provided.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 554 characters |" }, "duties_payor": { "description": "Specifies who will pay the duties for the shipment. Only accepted for FedEx shipments.", "type": "object", "properties": { "account": { "type": "string", "description": "Account number to be billed for duties.", "example": "2323434543" }, "type": { "enum": [ "SENDER", "RECIPIENT", "THIRD_PARTY" ], "description": "Party to be billed for duties.", "example": "THIRD_PARTY" }, "address": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of the party to be billed for duties.", "example": "Patrick Kavanagh" }, "zip": { "type": "string", "description": "Postal code of the party to be billed for duties.", "example": "80331" }, "country": { "type": "string", "description": "Country ISO code of account number to be billed.", "example": "DE" } } } } }, "exporter_identification": { "$ref": "#/components/schemas/CustomsExporterIdentification" }, "exporter_reference": { "type": "string", "description": "Exporter reference of an export shipment." }, "importer_reference": { "type": "string", "description": "Importer reference of an import shipment." }, "is_vat_collected": { "type": "boolean", "description": "Indicates whether the shipment's destination VAT has been collected. May be required for some destinations." }, "invoice": { "example": "#123123", "type": "string", "maxLength": 15, "description": "Invoice reference of the shipment." }, "license": { "type": "string", "description": "License reference of the shipment." }, "metadata": { "example": "Order ID #123123", "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you \nwant to attach to the object." }, "notes": { "type": "string", "description": "Additional notes to be included in the customs declaration." } }, "required": [ "certify_signer", "certify", "non_delivery_option", "contents_type" ], "type": "object" }, "CustomsDeclarationB13AFilingOption": { "type": "string", "example": "FILED_ELECTRONICALLY", "description": "B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). \n More information on reporting commercial exports from Canada. \nAllowed values available here" }, "CustomsDeclarationB13AFilingOptionEnum": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationB13AFilingOption" }, { "enum": [ "FILED_ELECTRONICALLY", "SUMMARY_REPORTING", "NOT_REQUIRED" ] } ] }, "CustomsDeclarationContentsType": { "type": "string", "description": "Type of goods of the shipment. \nAllowed values available here", "example": "MERCHANDISE" }, "CustomsDeclarationContentsTypeEnum": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationContentsType" }, { "enum": [ "DOCUMENTS", "GIFT", "SAMPLE", "MERCHANDISE", "HUMANITARIAN_DONATION", "RETURN_MERCHANDISE", "OTHER" ] } ] }, "CustomsDeclarationEelPfc": { "type": "string", "description": "EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most \nother shipments from the US, `NOEEI_30_37_a` is applicable.\nAllowed values available here", "example": "NOEEI_30_37_a" }, "CustomsDeclarationEelPfcEnum": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationEelPfc" }, { "enum": [ "NOEEI_30_37_a", "NOEEI_30_37_h", "NOEEI_30_37_f", "NOEEI_30_36", "AES_ITN" ] } ] }, "CustomsDeclarationIncoterm": { "type": "string", "description": "The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only.\neDAP is available for DPD UK only. DAP is available for DHL Express, FedEx, and DPD UK.\nIf expecting DAP for other carriers, please use DDU.\nAllowed values available here\nCarrier-specific restrictions are in the table below.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Must be one of DDP, DDU, FCA, DAP |", "example": "DDP" }, "CustomsDeclarationIncotermEnum": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationIncoterm" }, { "enum": [ "DDP", "DDU", "FCA", "DAP", "eDAP" ] } ] }, "CustomsDeclarationNonDeliveryOption": { "type": "string", "description": "Indicates how the carrier should proceed in case the shipment can't be delivered.\nAllowed values available here", "example": "RETURN" }, "CustomsDeclarationNonDeliveryOptionEnum": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationNonDeliveryOption" }, { "enum": [ "ABANDON", "RETURN" ] } ] }, "CustomsDeclaration": { "title": "Customs Declaration", "x-tags": [ "Customs Declarations" ], "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationBase" }, { "properties": { "address_importer": { "type": "string", "example": "257ba08436604d2aaf069caafe7acb2a", "description": "Object ID of the Importer address." }, "b13a_filing_option": { "$ref": "#/components/schemas/CustomsDeclarationB13AFilingOption" }, "contents_type": { "$ref": "#/components/schemas/CustomsDeclarationContentsType" }, "eel_pfc": { "$ref": "#/components/schemas/CustomsDeclarationEelPfc" }, "incoterm": { "$ref": "#/components/schemas/CustomsDeclarationIncoterm" }, "invoiced_charges": { "$ref": "#/components/schemas/CustomsInvoicedCharges" }, "items": { "example": [ "5087f181d1dc4b14b73fdbf636498886" ], "items": { "type": "string" }, "type": "array", "description": "Distinct Parcel content items as Customs Items object_ids." }, "non_delivery_option": { "$ref": "#/components/schemas/CustomsDeclarationNonDeliveryOption" }, "object_created": { "example": "2014-07-17T01:01:08.306Z", "format": "date-time", "type": "string", "description": "Date and time of object creation." }, "object_id": { "example": "e2197a54da9d470480f4f8796cc419cb", "type": "string", "description": "Unique identifier of the given object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the object." }, "object_state": { "$ref": "#/components/schemas/ObjectStateEnum" }, "object_updated": { "example": "2014-07-17T01:01:08.306Z", "format": "date-time", "type": "string", "description": "Date and time of last object update." }, "test": { "example": true, "type": "boolean", "description": "Indicates whether the object has been created in test mode." } }, "required": [ "items" ] } ] }, "CustomsDeclarationCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/CustomsDeclarationBase" }, { "properties": { "address_importer": { "$ref": "#/components/schemas/AddressImporter" }, "b13a_filing_option": { "$ref": "#/components/schemas/CustomsDeclarationB13AFilingOptionEnum" }, "contents_type": { "$ref": "#/components/schemas/CustomsDeclarationContentsTypeEnum" }, "eel_pfc": { "$ref": "#/components/schemas/CustomsDeclarationEelPfcEnum" }, "incoterm": { "$ref": "#/components/schemas/CustomsDeclarationIncotermEnum" }, "items": { "items": { "$ref": "#/components/schemas/CustomsItemCreateRequest" }, "type": "array" }, "non_delivery_option": { "$ref": "#/components/schemas/CustomsDeclarationNonDeliveryOptionEnum" }, "test": { "example": true, "type": "boolean" } }, "required": [ "items" ] } ] }, "CustomsDeclarationPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/CustomsDeclaration" }, "type": "array" } } } ] }, "CustomsExporterIdentification": { "description": "Additional exporter identification that may be required to ship in certain countries", "properties": { "eori_number": { "example": "PL123456790ABCDE", "type": "string", "description": "Economic Operators' Registration and Identification (EORI) number. Must start with a 2 character \ncountry code followed by a 6-17 character alphanumeric identifier (e.g. PL1234567890ABCDE).\nMore information on EORI." }, "tax_id": { "$ref": "#/components/schemas/CustomsTaxIdentification" } }, "type": "object" }, "CustomsInvoicedCharges": { "description": "Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice.", "properties": { "currency": { "type": "string", "format": "iso-4217", "description": "Currency for the invoiced charges amounts incurred on the end consumer." }, "total_shipping": { "type": "string", "description": "Total shipping paid by the buyer." }, "total_taxes": { "type": "string", "description": "Total taxes paid by the buyer." }, "total_duties": { "type": "string", "description": "Total duties paid by the buyer." }, "other_fees": { "type": "string", "description": "Other fees paid by the buyer." } }, "required": [ "currency" ], "type": "object" }, "CustomsItemBase": { "properties": { "description": { "example": "T-Shirt", "type": "string", "description": "Text description of your item." }, "eccn_ear99": { "type": "string", "description": "Export Control Classification Number, required on some exports from the United States." }, "mass_unit": { "$ref": "#/components/schemas/WeightUnitEnum" }, "metadata": { "example": "Order ID \"123454\"", "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you \nwant to attach to the object." }, "net_weight": { "example": "5", "type": "string", "description": "Total weight of this item, i.e. quantity * weight per item." }, "origin_country": { "type": "string", "description": "Country of origin of the item. Example: `US` or `DE`. \nAll accepted values can be found on the Official ISO Website." }, "quantity": { "example": 20, "format": "int64", "type": "integer", "description": "Quantity of this item in the shipment you send. Must be greater than 0." }, "sku_code": { "description": "SKU code of the item, which is required by some carriers.", "example": "HM-123", "type": "string" }, "hs_code": { "description": "HS code of the item, which is required by some carriers. If `tariff_number` is not provided, `hs_code` will be used. If both `hs_code` and `tariff_number` are provided, `tariff_number` will be used. 50 character limit.", "example": "0901.21", "type": "string" }, "tariff_number": { "type": "string", "description": "The tariff number of the item. If `tariff_number` is not provided, `hs_code` will be used. If both `hs_code` and `tariff_number` are provided, `tariff_number` will be used. 12 character limit." }, "value_amount": { "example": "200", "type": "string", "description": "Total value of this item, i.e. quantity * value per item." }, "value_currency": { "example": "USD", "type": "string", "description": "Currency used for value_amount. The official ISO 4217 \ncurrency codes are used, e.g. `USD` or `EUR`." } }, "required": [ "description", "quantity", "net_weight", "mass_unit", "value_amount", "value_currency", "origin_country" ], "type": "object" }, "CustomsItem": { "title": "Customs Item", "x-tags": [ "Customs Items" ], "allOf": [ { "$ref": "#/components/schemas/CustomsItemBase" }, { "properties": { "object_created": { "example": "2014-07-17T00:49:20.631Z", "format": "date-time", "type": "string", "description": "Date and time of object creation." }, "object_id": { "example": "d799c2679e644279b59fe661ac8fa488", "type": "string", "description": "Unique identifier of the given object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the object." }, "object_state": { "$ref": "#/components/schemas/ObjectStateEnum" }, "object_updated": { "example": "2014-07-17T00:49:20.631Z", "format": "date-time", "type": "string", "description": "Date and time of last object update." }, "test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." } } } ] }, "CustomsItemCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/CustomsItemBase" } ], "x-speakeasy-name-override": "CustomsItemCreateRequest", "x-speakeasy-include": true }, "CustomsItemPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/CustomsItem" }, "type": "array" } } } ] }, "CustomsTaxIdentification": { "description": "Tax identification that may be required to ship in certain countries. Typically used to assess duties on \ngoods that are crossing a border.", "properties": { "number": { "example": "123456789", "type": "string", "maxLength": 15, "description": "Tax identification number." }, "type": { "example": "EIN", "enum": [ "EIN", "VAT", "IOSS", "ARN" ], "description": "Type of tax identification.\n* `EIN` - Employer Identification Number, also known as a Federal Tax Identification Number.\n* `VAT` - Value Added Tax identification number.\n* `IOSS` - Import One-Stop Shop\n* `ARN` - Australian Taxation Office Reference Number" } }, "type": "object" }, "DangerousGoodsBiologicalMaterial": { "description": "Container for specifying the presence of biological material.", "properties": { "contains": { "type": "boolean", "description": "Indicates if the shipment contains biological material." } }, "type": "object" }, "DangerousGoodsLithiumBatteries": { "description": "Container for specifying the presence of lithium batteries.", "properties": { "contains": { "type": "boolean", "description": "Indicates if the shipment contains lithium batteries." } }, "type": "object" }, "DangerousGoodsObject": { "description": "Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents\nare provided, only certain USPS service levels will be eligible. For more information, see our\nguide on hazardous or dangerous materials shipping.", "properties": { "contains": { "type": "boolean", "description": "Indicates if the shipment contains dangerous goods." }, "biological_material": { "$ref": "#/components/schemas/DangerousGoodsBiologicalMaterial" }, "lithium_batteries": { "$ref": "#/components/schemas/DangerousGoodsLithiumBatteries" } }, "type": "object" }, "DefaultParcelTemplate": { "title": "Default Parcel Template", "x-tags": [ "Rates at Checkout" ], "properties": { "result": { "$ref": "#/components/schemas/UserParcelTemplate" } }, "type": "object" }, "DefaultParcelTemplateUpdateRequest": { "properties": { "object_id": { "example": "b958d3690bb04bb8b2986724872750f5", "type": "string" } }, "type": "object" }, "DepartmentNumber": { "description": "Specify the department number field on the label (FedEx and UPS only).", "properties": { "prefix": { "type": "string", "description": "Custom prefix for department number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property." }, "value": { "type": "string", "maxLength": 40, "description": "Optional text to be printed on the shipping label for department number. Up to 40 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 3 } }, "type": "object" }, "DryIce": { "description": "Specify that the package contains Dry Ice (FedEx, Veho, and UPS only).", "properties": { "contains_dry_ice": { "type": "boolean", "description": "Mandatory. Specifies that the package contains Dry Ice." }, "weight": { "type": "string", "description": "Mandatory. Units must be in Kilograms. Cannot be greater than package weight." } }, "type": "object" }, "LiveRate": { "title": "Live Rate", "x-tags": [ "Rates at Checkout" ], "allOf": [ { "$ref": "#/components/schemas/RateAmountAndCurrency" }, { "properties": { "estimated_days": { "description": "The estimated days in transit of the rate that powers the shipping option, if available.", "example": 2, "format": "int64", "type": "integer" }, "title": { "description": "The name of the service group being returned", "example": "Shipping Option 1", "type": "string" } } } ], "type": "object" }, "LiveRatePaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "count": { "example": 123, "format": "int64", "type": "integer" }, "results": { "items": { "$ref": "#/components/schemas/LiveRate" }, "type": "array" } } } ] }, "Location": { "description": "Location where the parcel(s) will be picked up.", "properties": { "address": { "$ref": "#/components/schemas/AddressPickupCompleteCreateRequest" }, "building_location_type": { "enum": [ "Back Door", "Ring Bell", "Security Deck", "Shipping Dock", "Front Door", "Knock on Door", "In/At Mailbox", "Mail Room", "Office", "Other", "Reception", "Side Door" ], "example": "Front Door", "type": "string", "description": "Where your parcels will be available for pickup. \"Security Deck\" and \"Shipping Dock\" are only \nsupported for DHL Express." }, "building_type": { "enum": [ "apartment", "building", "department", "floor", "room", "suite" ], "example": "apartment", "type": "string", "description": "The type of building where the pickup is located." }, "instructions": { "example": "Behind screen door", "type": "string", "description": "Pickup instructions for the courier. This is a mandatory field if the building_location_type is \"Other\"." } }, "required": [ "building_location_type", "address" ], "type": "object" }, "ManifestBase": { "properties": { "carrier_account": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "ID of carrier account" }, "shipment_date": { "example": "2014-05-16T23:59:59Z", "type": "string", "description": "All shipments to be submitted on this day will be closed out. \nMust be in the format `2014-01-18T00:35:03.463Z` (ISO 8601 date)." }, "transactions": { "example": [ "adcfdddf8ec64b84ad22772bce3ea37a" ], "items": { "type": "string" }, "type": "array", "description": "IDs transactions to use. If you set this to null or not send this parameter, \nShippo will automatically assign all applicable transactions." } }, "required": [ "carrier_account", "shipment_date" ], "type": "object" }, "Manifest": { "x-tags": [ "Manifests" ], "allOf": [ { "$ref": "#/components/schemas/ManifestBase" }, { "properties": { "address_from": { "example": "d799c2679e644279b59fe661ac8fa488", "type": "string", "description": "ID of the Address object that should be used as pickup address for the scan form. \nThe USPS will validate this address before creating the scan form." }, "documents": { "example": [ "https://shippo-delivery.s3.amazonaws.com/0fadebf6f60c4aca95fa01bcc59c79ae.pdf?Signature=tlQU3RECwdHUQJQadwqg5bAzGFQ%3D&Expires=1402803835&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA" ], "items": { "type": "string" }, "type": "array", "description": "An array containing the URLs to all returned manifest documents." }, "errors": { "items": { "type": "string" }, "type": "array", "description": "An array of codes and messages describing the error that occurred if any." }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of object creation." }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the given object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the object." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last object update." }, "status": { "enum": [ "QUEUED", "SUCCESS", "ERROR" ], "example": "SUCCESS", "type": "string", "description": "Indicates the status of the manifest." } }, "required": [ "status", "object_created", "object_updated", "object_id", "object_owner", "documents", "address_from" ] } ] }, "ManifestErrors": { "title": "Manifest Errors", "x-tags": [ "Manifests" ], "description": "The following codes and messages are the possible errors that may occur when creating Manifests.", "properties": { "generic_carrier_error": { "type": "string", "description": "There is an error from the carrier that requires investigation. Please contact support with the object ID of this response." }, "carrier_account_invalid_credentials": { "type": "string", "description": "The carrier account contains invalid credentials. Please update your carrier account with valid credentials." }, "carrier_account_access_denied": { "type": "string", "description": "There is an issue with your carrier account. Please contact support with the information of your account manager at the carrier and the object ID of this response." }, "manifest_invalid_transactions": { "type": "string", "description": "For this carrier, all shipments must be manifested on the same day that they are created regardless of shipment date." }, "manifest_no_transactions": { "type": "string", "description": "There are no shipments in the manifest. Please check that the shipment date of the shipments matches the shipment date of the manifest." }, "address_from_missing_zip": { "type": "string", "description": "The sender address is missing the zip. Please update the sender address and try again." }, "address_from_invalid_zip1": { "type": "string", "description": "The sender address contains an invalid zip. Please update the sender address and try again." }, "address_from_invalid_zip2": { "type": "string", "description": "The sender address contains an invalid zip. Please update the sender address and try again. You can also try removing the last 4 digits of the zip." }, "address_from_missing_city": { "type": "string", "description": "The sender address is missing the city. Please update the sender address and try again." }, "address_from_invalid_city": { "type": "string", "description": "The sender address contains an invalid city. Please update the sender address and try again." }, "address_from_missing_state": { "type": "string", "description": "The sender address is missing the state. Please update the sender address and try again." }, "address_from_invalid_state": { "type": "string", "description": "The sender address contains an invalid state. Please update the sender address and try again." }, "address_from_missing_name": { "type": "string", "description": "The sender address is missing the name. Please update the sender address and try again." }, "shipment_date_missing": { "type": "string", "description": "The shipment date is missing. Please update the shipment date and try again." }, "shipment_date_invalid": { "type": "string", "description": "The shipment date is invalid. Please update the shipment date and try again." } } }, "ManifestCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/ManifestBase" }, { "properties": { "address_from": { "oneOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" }, { "type": "string", "description": "ID of the Address object that should be used as pickup address for the scan form. \nThe USPS will validate this address before creating the scan form." } ] }, "async": { "type": "boolean" } }, "required": [ "address_from" ] } ], "type": "object" }, "ManifestPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Manifest" }, "type": "array" } } } ] }, "OrderBase": { "properties": { "currency": { "description": "**Required if total_price is provided**
\nCurrency of the total_price and total_tax amounts.", "example": "USD", "type": "string" }, "notes": { "description": "Custom buyer- or seller-provided notes about the order.", "example": "This customer is a VIP", "type": "string" }, "order_number": { "description": "An alphanumeric identifier for the order used by the seller/buyer. This identifier doesn't need to be unique.", "example": "#1068", "type": "string" }, "order_status": { "$ref": "#/components/schemas/OrderStatusEnum" }, "placed_at": { "description": "Date and time when the order was placed. This datetime can be different from the datetime of the order object creation on Shippo.", "example": "2016-09-23T01:28:12Z", "type": "string" }, "shipping_cost": { "description": "Amount paid by the buyer for shipping. This amount can be different from the price the seller will actually pay for shipping.", "example": "12.83", "type": "string" }, "shipping_cost_currency": { "description": "**Required if shipping_cost is provided**
\nCurrency of the shipping_cost amount.", "example": "USD", "type": "string" }, "shipping_method": { "description": "Shipping method (carrier + service or other free text description) chosen by the buyer. \nThis value can be different from the shipping method the seller will actually choose.", "example": "USPS First Class Package", "type": "string" }, "subtotal_price": { "example": "12.1", "type": "string" }, "total_price": { "description": "Total amount paid by the buyer for this order.", "example": "24.93", "type": "string" }, "total_tax": { "description": "Total tax amount paid by the buyer for this order.", "example": "0.0", "type": "string" }, "weight": { "example": "0.4", "type": "string", "description": "Total weight of the order." }, "weight_unit": { "$ref": "#/components/schemas/WeightUnitEnum" } }, "required": [ "placed_at" ], "type": "object" }, "OrderStatusEnum": { "type": "string", "description": "Current state of the order. See the orders tutorial \nfor the logic of how the status is handled.", "enum": [ "UNKNOWN", "AWAITPAY", "PAID", "REFUNDED", "CANCELLED", "PARTIALLY_FULFILLED", "SHIPPED" ], "example": "PAID" }, "Order": { "x-tags": [ "Orders" ], "allOf": [ { "$ref": "#/components/schemas/OrderBase" }, { "properties": { "from_address": { "$ref": "#/components/schemas/AddressFrom" }, "to_address": { "$ref": "#/components/schemas/AddressTo" }, "line_items": { "description": "Array of line item objects representing the items in this order. \nAll objects will be returned expanded by default.", "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array" }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the order object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the object." }, "shop_app": { "$ref": "#/components/schemas/OrderShopAppEnum" }, "transactions": { "items": { "type": "object" }, "type": "array", "description": "Array of transaction objects representing all shipping labels purchased for this order.\nAll objects are returned expanded with a limited number of fields by default." } }, "required": [ "to_address" ] } ] }, "OrderShopAppEnum": { "type": "string", "description": "Platform the order was created on and, if applicable, imported from. \nOrders created via the Shippo API or dashboard will have the value \"Shippo\".", "example": "Shippo", "enum": [ "Amazon", "Bigcommerce", "CSV_Import", "eBay", "ePages", "Etsy", "Godaddy", "Magento", "Shippo", "Shopify", "Spreecommerce", "StripeRelay", "Walmart", "Weebly", "WooCommerce" ] }, "OrderCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/OrderBase" }, { "properties": { "from_address": { "$ref": "#/components/schemas/AddressFromCreateRequest" }, "to_address": { "$ref": "#/components/schemas/AddressToCreateRequest" }, "line_items": { "description": "Array of line item objects representing the items in this order. \nAll objects will be returned expanded by default.", "items": { "$ref": "#/components/schemas/LineItemCreateRequest" }, "type": "array" } }, "required": [ "to_address" ] } ] }, "OrderPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Order" }, "type": "array" } } } ] }, "ParcelBase": { "properties": { "extra": { "$ref": "#/components/schemas/ParcelExtra" }, "metadata": { "type": "string", "example": "Customer ID 123456" }, "mass_unit": { "$ref": "#/components/schemas/WeightUnitEnum" }, "weight": { "description": "Weight of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.", "example": "1", "type": "string" } }, "type": "object" }, "ParcelDimensions": { "properties": { "distance_unit": { "$ref": "#/components/schemas/DistanceUnitEnum", "description": "The measure unit used for length, width and height." }, "height": { "description": "Height of the parcel. Up to six digits in front and four digits after the decimal separator are accepted.", "example": "1", "type": "string" }, "length": { "description": "Length of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.", "example": "1", "type": "string" }, "width": { "description": "Width of the Parcel. Up to six digits in front and four digits after the decimal separator are accepted.", "example": "1", "type": "string" } }, "type": "object" }, "Parcel": { "x-tags": [ "Parcels" ], "allOf": [ { "$ref": "#/components/schemas/ParcelBase" }, { "$ref": "#/components/schemas/ParcelDimensions" }, { "properties": { "object_created": { "description": "Date and time of Parcel creation.", "example": "2014-07-09T02:19:13.174Z", "format": "date-time", "type": "string" }, "object_id": { "description": "Unique identifier of the given Parcel object. This ID is required to create a Shipment object.", "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" }, "object_owner": { "description": "Username of the user who created the Parcel object.", "example": "shippotle@shippo.com", "type": "string" }, "object_state": { "description": "A Parcel will only be valid when all required values have been sent and validated successfully.", "example": "VALID", "enum": [ "VALID" ], "type": "string" }, "object_updated": { "description": "Date and time of last Parcel update. Since you cannot update Parcels after they were created, this time stamp reflects the time when the Parcel was changed by Shippo's systems for the last time, e.g., during sorting the dimensions given.", "example": "2014-07-09T02:19:13.174Z", "format": "date-time", "type": "string" }, "template": { "$ref": "#/components/schemas/ParcelTemplateEnumSet" }, "test": { "description": "Indicates whether the object has been created in test mode.", "type": "boolean" } } } ], "required": [ "length", "width", "height", "distance_unit", "weight", "mass_unit" ], "type": "object" }, "ParcelCreateFromTemplateRequest": { "allOf": [ { "$ref": "#/components/schemas/ParcelBase" }, { "properties": { "template": { "$ref": "#/components/schemas/ParcelTemplateEnumSet" } } } ], "required": [ "template", "weight", "mass_unit" ], "type": "object" }, "ParcelCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/ParcelBase" }, { "$ref": "#/components/schemas/ParcelDimensions" } ], "required": [ "length", "width", "height", "distance_unit", "weight", "mass_unit" ], "type": "object" }, "ParcelPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Parcel" }, "type": "array" } } } ] }, "ParcelExtra": { "title": "Parcel Extra", "x-tags": [ "Parcels" ], "description": "An object holding optional extra services to be requested for each parcel in a multi-piece shipment.\nThe following values are supported for the `extra` field of the parcel object.", "properties": { "COD": { "$ref": "#/components/schemas/COD" }, "insurance": { "$ref": "#/components/schemas/ParcelInsurance" }, "reference_1": { "type": "string", "maxLength": 50, "description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) |" }, "reference_2": { "type": "string", "maxLength": 50, "description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |" } }, "type": "object" }, "ParcelInsurance": { "description": "To add insurance to your parcel, specify `amount`, `content` and `currency`.

If you do not want to add insurance to you parcel, do not set these parameters.", "properties": { "amount": { "description": "Declared value of the goods you want to insure.", "example": "5.5", "type": "string" }, "content": { "description": "Description of parcel content.", "example": "Laptop", "type": "string" }, "currency": { "description": "Currency for the amount value. Currently only USD is supported for FedEx and UPS.", "example": "USD", "type": "string" }, "provider": { "description": "To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set provider to `FEDEX`, `UPS`, or `ONTRAC`.", "example": "UPS", "type": "string", "enum": [ "FEDEX", "UPS", "ONTRAC" ] } }, "type": "object" }, "PickupBase": { "properties": { "carrier_account": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "The object ID of your USPS or DHL Express carrier account. \nYou can retrieve this from your Rate requests or our Carrier Accounts endpoint." }, "location": { "$ref": "#/components/schemas/Location" }, "metadata": { "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you \nwant to attach to the object." }, "requested_end_time": { "format": "date-time", "type": "string", "description": "The latest that you requested your parcels to be available for pickup. \nExpressed in the timezone specified in the response." }, "requested_start_time": { "format": "date-time", "type": "string", "description": "The earliest that you requested your parcels to be ready for pickup. \nExpressed in the timezone specified in the response." }, "transactions": { "example": [ "adcfdddf8ec64b84ad22772bce3ea37a" ], "items": { "type": "string" }, "type": "array", "description": "The transaction(s) object ID(s) for the parcel(s) that need to be picked up." } }, "required": [ "carrier_account", "location", "transactions", "requested_start_time", "requested_end_time" ], "type": "object" }, "Pickup": { "x-tags": [ "Pickups" ], "allOf": [ { "$ref": "#/components/schemas/PickupBase" }, { "properties": { "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Pickup creation." }, "object_id": { "type": "string", "description": "Unique identifier of the given Pickup object." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last Pickup update." }, "confirmed_start_time": { "type": "string", "format": "datetime", "example": "2020-05-09T12:00:00Z", "description": "The earliest that your parcels will be ready for pickup, confirmed by the carrier. \nExpressed in the timezone specified in the response." }, "confirmed_end_time": { "type": "string", "format": "datetime", "example": "2020-05-09T23:59:59.999Z", "description": "The latest that your parcels will be available for pickup, confirmed by the carrier. \nExpressed in the timezone specified in the response." }, "cancel_by_time": { "type": "string", "format": "datetime", "example": "2020-05-09T08:00:00Z", "description": "The latest time to cancel a pickup. Expressed in the timezone specified in the response. \nTo cancel a pickup, you will need to contact the carrier directly. \nThe ability to cancel a pickup through Shippo may be released in future iterations." }, "status": { "type": "string", "example": "CONFIRMED", "description": "Indicates the status of the pickup.", "enum": [ "PENDING", "CONFIRMED", "ERROR", "CANCELLED" ] }, "confirmation_code": { "type": "string", "example": "WTC310058750", "description": "Pickup's confirmation code returned by the carrier. \nTo edit or cancel a pickup, you will need to contact USPS or DHL Express directly and provide your `confirmation_code`." }, "timezone": { "type": "string", "example": "US/Pacific", "description": "The pickup time windows will be in the time zone specified here, not UTC." }, "messages": { "type": "array", "items": { "type": "string" }, "example": [], "description": "An array containing strings of any messages generated during validation." }, "is_test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." } } } ] }, "PickupCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/PickupBase" } ] }, "BadRequest": { "additionalProperties": true, "type": "object" }, "PoNumber": { "description": "Specify the PO number field on the label (FedEx and UPS only).", "properties": { "prefix": { "type": "string", "description": "Custom prefix for PO number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property." }, "value": { "type": "string", "maxLength": 40, "description": "Optional text to be printed on the shipping label for PO number. Up to 40 characters. If\nthis is provided, reference_2 will be ignored.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 2 } }, "type": "object" }, "CarrierAccountPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/CarrierAccountWithExtraInfo" }, "type": "array" } } } ] }, "RateAmountAndCurrency": { "properties": { "amount": { "example": "5.5", "type": "string", "description": "Final Rate price, expressed in the currency used in the sender's country." }, "amount_local": { "example": "5.5", "type": "string", "description": "Final Rate price, expressed in the currency used in the recipient's country." }, "currency": { "example": "USD", "type": "string", "description": "Currency used in the sender's country, refers to `amount`. \nThe official ISO 4217 currency codes are used, e.g. `USD` or `EUR`." }, "currency_local": { "example": "USD", "type": "string", "description": "Currency used in the recipient's country, refers to `amount_local`. \nThe official ISO 4217 currency codes are used, e.g. `USD` or \"EUR\"." } } }, "Rate": { "x-tags": [ "Rates" ], "allOf": [ { "$ref": "#/components/schemas/RateAmountAndCurrency" }, { "properties": { "arrives_by": { "type": "string", "example": "08:30:00", "description": "Predicted time the carrier will deliver the package in the destination's local time zone. In the format `HH:MM:SS`." }, "attributes": { "items": { "enum": [ "BESTVALUE", "CHEAPEST", "FASTEST" ], "type": "string" }, "type": "array", "description": "An array containing specific attributes of this Rate in context of the entire shipment. \nAttributes can be assigned `CHEAPEST`, `FASTEST`, or `BESTVALUE`." }, "carrier_account": { "example": "078870331023437cb917f5187429b093", "type": "string", "description": "Object ID of the carrier account that has been used to retrieve the rate." }, "duration_terms": { "example": "Delivery in 1 to 3 business days", "type": "string", "description": "Further clarification of the transit times. \nOften, this includes notes that the transit time as given in \"days\" is only an average, not a guaranteed time." }, "estimated_days": { "example": 2, "format": "int64", "type": "integer", "description": "Estimated transit time (duration) in days of the Parcel at the given servicelevel. \nPlease note that this is not binding, but only an average value as given by the provider. \nShippo is not able to guarantee any transit times." }, "included_insurance_price": { "example": "1.05", "type": "string", "description": "Cost to the user to insure the Rate for the requested amount of coverage, if insurance coverage was requested. \nExpressed in the currency used in the sender's country. Will be null if no insurance coverage was requested, or if insurance is requested from a non-standard insurance provider. \nPlease note this price is already included in the `amount` and `amount_local` fields on the Rate. Do not add this field to them." }, "messages": { "$ref": "#/components/schemas/ResponseMessageList" }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Rate creation." }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the given Rate object." }, "object_owner": { "example": "pp@gmail.com", "type": "string", "description": "Username of the user who created the rate object." }, "provider": { "example": "USPS", "type": "string", "description": "Carrier offering the rate, e.g., `FedEx` or `Deutsche Post DHL`." }, "provider_image_75": { "example": "https://cdn2.goshippo.com/providers/75/USPS.png", "type": "string", "description": "URL to the provider logo with max. dimensions of 75*75px. \nPlease refer to the provider's Logo Usage Guidelines before using the logo." }, "provider_image_200": { "example": "https://cdn2.goshippo.com/providers/200/USPS.png", "type": "string", "description": "URL to the provider logo with max. dimensions of 200*200px. \nPlease refer to the provider's Logo Usage Guidelines before using the logo." }, "servicelevel": { "$ref": "#/components/schemas/ServiceLevelWithParent" }, "shipment": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" }, "test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." }, "zone": { "type": "string", "example": "1", "description": "The parcel's transit zone token. These tokens can vary depending on the provider." } }, "required": [ "object_created", "object_id", "object_owner", "shipment", "attributes", "amount", "currency", "amount_local", "currency_local", "provider", "servicelevel", "carrier_account" ] } ], "type": "object" }, "RatePaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Rate" }, "type": "array" } } } ] }, "ResponseMessageList": { "items": { "$ref": "#/components/schemas/ResponseMessage" }, "type": "array" }, "ResponseMessage": { "description": "Message returned with supporting information from a request. In some cases this can be an error message, \nfor example a timeout from a carrier. If available, the origin of the message is displayed in `source`.", "properties": { "source": { "description": "Origin of message", "example": "UPS", "type": "string" }, "code": { "description": "Classification of message", "example": "carrier_timeout", "type": "string" }, "text": { "description": "Message content", "example": "UPS API did not respond. Please try again in a few minutes.", "type": "string" } }, "type": "object" }, "Refund": { "x-tags": [ "Refunds" ], "properties": { "object_created": { "format": "date-time", "type": "string", "description": "Date and time of object creation." }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the given object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the object." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last object update." }, "status": { "enum": [ "QUEUED", "PENDING", "SUCCESS", "ERROR" ], "example": "SUCCESS", "type": "string", "description": "Indicates the status of the Refund." }, "test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." }, "transaction": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string", "description": "Object ID of the Transaction to be refunded." } }, "type": "object" }, "RefundRequestBody": { "properties": { "async": { "example": false, "type": "boolean" }, "transaction": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string" } }, "required": [ "transaction" ], "type": "object" }, "RefundPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Refund" }, "type": "array" } } } ] }, "RmaNumber": { "description": "Specify the RMA number field on the label (FedEx and UPS only).", "properties": { "prefix": { "type": "string", "description": "Custom prefix for RMA number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property." }, "value": { "type": "string", "maxLength": 40, "description": "Optional text to be printed on the shipping label for RMA number. Up to 40 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 20 characters |" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 1 } }, "type": "object" }, "ServiceGroupBase": { "properties": { "description": { "example": "USPS shipping options", "type": "string", "description": "Description for the service group" }, "flat_rate": { "description": "String representation of an amount to be returned as the flat rate\nif 1. The service group is of type `LIVE_RATE` and no matching rates\nwere found; or 2. The service group is of type `FLAT_RATE`. Either\nintegers or decimals are accepted. Required unless type is\n`FREE_SHIPPING`", "example": "5", "type": "string" }, "flat_rate_currency": { "description": "required unless type is `FREE_SHIPPING`. (ISO 4217 currency)", "example": "USD", "type": "string" }, "free_shipping_threshold_currency": { "description": "optional unless type is `FREE_SHIPPING`. (ISO 4217 currency)", "example": "USD", "type": "string" }, "free_shipping_threshold_min": { "description": "For service groups of type `FREE_SHIPPING`, this field must be required to configure the minimum \ncart total (total cost of items in the cart) for this service group to be returned for rates at \ncheckout. Optional unless type is `FREE_SHIPPING`", "example": "5", "type": "string" }, "name": { "example": "USPS Shipping", "type": "string", "description": "Name for the service group that will be shown to customers in the response" }, "rate_adjustment": { "example": 15, "format": "int64", "type": "integer", "description": "The amount in percent (%) that the service group's returned rate should be adjusted. For example, if this field is set to 5 and the matched rate price is $5.00, the returned value of the service group will be $5.25. Negative integers are also accepted and will discount the rate price by the defined percentage amount." }, "type": { "$ref": "#/components/schemas/ServiceGroupTypeEnum" } }, "type": "object" }, "ServiceGroupTypeEnum": { "description": "The type of the service group.
\n`LIVE_RATE` - Shippo will make a rating request and return real-time rates for the shipping group, only falling back to the specified flat rate amount if no rates match a service level in the service group.
\n`FLAT_RATE` - Returns a shipping option with the specified flat rate amount.
\n`FREE_SHIPPING` - Returns a shipping option with a price of $0 only if the total cost of items exceeds the amount defined by `free_shipping_threshold_min`", "enum": [ "LIVE_RATE", "FLAT_RATE", "FREE_SHIPPING" ], "example": "FLAT_RATE", "type": "string" }, "ServiceGroup": { "title": "Service Group", "x-tags": [ "Service Groups" ], "allOf": [ { "$ref": "#/components/schemas/ServiceGroupBase" }, { "properties": { "object_id": { "description": "The unique identifier of the given Service Group object.", "example": "80feb1633d4a43c898f005850", "type": "string" }, "is_active": { "description": "True if the service group is enabled, false otherwise.", "example": true, "type": "boolean" }, "service_levels": { "items": { "$ref": "#/components/schemas/ServiceGroupAccountAndServiceLevel" }, "type": "array" } }, "required": [ "name", "description", "type", "service_levels", "object_id" ] } ] }, "ServiceGroupCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/ServiceGroupBase" }, { "properties": { "service_levels": { "items": { "$ref": "#/components/schemas/ServiceGroupAccountAndServiceLevel" }, "type": "array" } } }, { "required": [ "name", "description", "type", "service_levels" ] } ] }, "ServiceGroupUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/ServiceGroupBase" }, { "properties": { "object_id": { "description": "The unique identifier of the given Service Group object.", "example": "80feb1633d4a43c898f005850", "type": "string" }, "is_active": { "description": "True if the service group is enabled, false otherwise.", "example": true, "type": "boolean" }, "service_levels": { "items": { "$ref": "#/components/schemas/ServiceGroupAccountAndServiceLevel" }, "type": "array" } } }, { "required": [ "name", "description", "type", "service_levels", "object_id", "is_active" ] } ] }, "ServiceGroupAccountAndServiceLevel": { "properties": { "account_object_id": { "example": "80feb1633d4a43c898f0058506cfd82d", "type": "string", "description": "ID of a Carrier Account object" }, "service_level_token": { "example": "ups_next_day_air_saver", "type": "string", "description": "Service level token, e.g. `usps_priority` or `fedex_ground`.
\nSee Service Levels." } }, "type": "object" }, "ServiceLevel": { "description": "Contains details regarding the service level for the given rate.", "properties": { "name": { "example": "Priority Mail Express", "type": "string", "description": "Name of the Rate's servicelevel, e.g. `International Priority` or `Standard Post`. \nA servicelevel commonly defines the transit time of a Shipment (e.g., Express vs. Standard), along with other properties. \nThese names vary depending on the provider." }, "terms": { "type": "string", "description": "Further clarification of the service." }, "token": { "example": "usps_priority_express", "type": "string", "description": "Token of the Rate's servicelevel, e.g. `usps_priority` or `fedex_ground`. \nSee servicelevels." }, "extended_token": { "type": "string", "description": "Unique, extended version of the Service Level \"token\". \nGuaranteed to be unique across all Service Levels, and may help offer insight into the specific Service Level it describes." } }, "type": "object", "x-speakeasy-include": true }, "ServiceLevelWithParent": { "allOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "properties": { "parent_servicelevel": { "allOf": [ { "$ref": "#/components/schemas/ServiceLevel" }, { "description": "Used for some Service Levels to link to the more \"generic\" version of this Service Level - for example, \nif this Service Level is a variation specific to shipments to Europe(\"ups_saver_eu\"), the \"parent\" is \nthe fully generic version (\"ups_saver\"). Helpful when displaying Service Levels to users. Has the same \nstructure of the servicelevel - \"name\", \"token\", \"terms\", and \"extended_token\", or it is otherwise null." } ] } } } ] }, "ShipmentBase": { "properties": { "extra": { "$ref": "#/components/schemas/ShipmentExtra" }, "metadata": { "example": "Customer ID 123456", "type": "string", "maxLength": 100, "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object." }, "shipment_date": { "example": "2021-03-22T12:00:00Z", "type": "string", "description": "Date the shipment will be tendered to the carrier. Must be in the format `2014-01-18T00:35:03.463Z`. \nDefaults to current date and time if no value is provided. Please note that some carriers require this value to\nbe in the future, on a working day, or similar." } }, "type": "object" }, "Shipment": { "x-tags": [ "Shipments" ], "allOf": [ { "$ref": "#/components/schemas/ShipmentBase" }, { "description": "Shipment represents the parcel as retrieved from the database", "properties": { "address_from": { "$ref": "#/components/schemas/AddressFrom" }, "address_return": { "$ref": "#/components/schemas/AddressReturn" }, "address_to": { "$ref": "#/components/schemas/AddressTo" }, "carrier_accounts": { "items": { "type": "string" }, "type": "array", "description": "An array of object_ids of the carrier account objects to be used for getting shipping rates for this shipment. \nIf no carrier account object_ids are set in this field, Shippo will attempt to generate rates using all the \ncarrier accounts that have the `active` field set." }, "customs_declaration": { "$ref": "#/components/schemas/CustomsDeclaration" }, "messages": { "$ref": "#/components/schemas/ResponseMessageList" }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Shipment creation." }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the given Shipment object." }, "object_owner": { "example": "pp@gmail.com", "type": "string", "description": "Username of the user who created the Shipment object." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last Shipment update." }, "parcels": { "items": { "$ref": "#/components/schemas/Parcel" }, "type": "array", "description": "List of Parcel objects to be shipped." }, "rates": { "items": { "$ref": "#/components/schemas/Rate" }, "type": "array", "description": "An array with all available rates. If async has been set to false in the request,\nthis will be populated with all available rates in the response. Otherwise rates will be created\nasynchronously and this array will initially be empty." }, "status": { "enum": [ "ERROR", "QUEUED", "SUCCESS", "WAITING" ], "example": "QUEUED", "type": "string", "description": "`Waiting` shipments have been successfully submitted but not yet been processed. \n`Queued` shipments are currently being processed. \n`Success` shipments have been processed successfully, meaning that rate generation has concluded. \n`Error` does not occur currently and is reserved for future use." }, "test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." } }, "required": [ "address_to", "address_from", "parcels", "object_created", "object_updated", "object_id", "object_owner", "status", "rates", "carrier_accounts", "messages", "metadata" ] } ] }, "ShipmentCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/ShipmentBase" }, { "properties": { "address_from": { "oneOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" }, { "type": "string", "example": "d799c2679e644279b59fe661ac8fa488", "description": "Address `object_id` of a previously created address." } ] }, "address_return": { "oneOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" }, { "type": "string", "example": "d799c2679e644279b59fe661ac8fa488", "description": "Address `object_id` of a previously created address." } ] }, "address_to": { "oneOf": [ { "$ref": "#/components/schemas/AddressCreateRequest" }, { "type": "string", "example": "d799c2679e644279b59fe661ac8fa489", "description": "Address `object_id` of a previously created address." } ] }, "customs_declaration": { "oneOf": [ { "$ref": "#/components/schemas/CustomsDeclarationCreateRequest" }, { "type": "string", "example": "adcfdddf8ec64b84ad22772bce3ea37a", "description": "Customs Declaration `object_id` of a previously\ncreated customs declaration." } ] }, "async": { "type": "boolean" }, "carrier_accounts": { "items": { "type": "string" }, "type": "array", "description": "List of Carrier Accounts `object_id`s used to filter \nthe returned rates. If set, only rates from these carriers will be returned.", "example": [ "065a4a8c10d24a34ab932163a1b87f52", "73f706f4bdb94b54a337563840ce52b0" ] }, "parcels": { "type": "array", "description": "List of parcels to be shipped.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 items |", "items": { "oneOf": [ { "$ref": "#/components/schemas/ParcelCreateRequest" }, { "$ref": "#/components/schemas/ParcelCreateFromTemplateRequest" }, { "type": "string", "description": "Parcel `object_id` of a previously created parcel." } ] } } }, "required": [ "address_to", "address_from", "parcels" ] } ] }, "ShipmentPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Shipment" }, "type": "array" } } } ] }, "ShipmentExtra": { "title": "Shipment Extra", "x-tags": [ "Shipments" ], "description": "An object holding optional extra services to be requested.", "properties": { "accounts_receivable_customer_account": { "description": "UPS only. Adds custom accounts receivable customer account reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "alcohol": { "$ref": "#/components/schemas/Alcohol" }, "ancillary_endorsement": { "enum": [ "FORWARDING_SERVICE_REQUESTED", "RETURN_SERVICE_REQUESTED" ], "description": "Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only)." }, "appropriation_number": { "description": "UPS only. Adds custom appropriation number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "authority_to_leave": { "type": "boolean", "description": "Request `true` to give carrier permission to leave the parcel in a safe place if no one answers the \ndoor (where supported). When set to `false`, if no one is available to receive the item, the parcel \nwill not be left (*surcharges may be applicable)." }, "bill_of_lading_number": { "description": "UPS only. Adds custom bill of lading number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "billing": { "$ref": "#/components/schemas/Billing" }, "bypass_address_validation": { "type": "boolean", "description": "Bypasses address validation (USPS, UPS, & LaserShip only)." }, "carbon_neutral": { "type": "boolean", "description": "Request carbon offsets by passing true (UPS only)." }, "carrier_hub_id": { "type": "string", "description": "Identifies the carrier injection site." }, "carrier_hub_travel_time": { "type": "integer", "description": "Travel time in hours from fulfillment center to carrier injection site." }, "COD": { "$ref": "#/components/schemas/COD" }, "cod_number": { "description": "UPS only. Adds custom COD number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "container_type": { "type": "string", "description": "Specify container type." }, "critical_pull_time": { "type": "string", "description": "Carrier arrival time to pickup packages from the fulfillment center. \nUTC format: `%Y-%m-%dT%H:%M:%SZ`" }, "customer_branch": { "type": "string", "description": "Specify customer branch (Lasership only)." }, "customer_reference": { "$ref": "#/components/schemas/CustomerReference" }, "dangerous_goods": { "$ref": "#/components/schemas/DangerousGoodsObject" }, "dangerous_goods_code": { "enum": [ "01", "02", "03", "04", "05", "06", "07", "08", "09" ], "description": "Dangerous Goods Code (DHL eCommerce only). See Category Codes" }, "dealer_order_number": { "description": "UPS only. Adds custom dealer order number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "delivery_instructions": { "type": "string", "description": "Specify delivery instructions. Up to 500 characters. (FedEx and OnTrac only)." }, "dept_number": { "$ref": "#/components/schemas/DepartmentNumber" }, "dry_ice": { "$ref": "#/components/schemas/DryIce" }, "fda_product_code": { "description": "UPS only. Adds custom FDA product code reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "fulfillment_center": { "type": "string", "description": "The fulfilment center where the package originates from." }, "insurance": { "$ref": "#/components/schemas/Insurance" }, "invoice_number": { "$ref": "#/components/schemas/InvoiceNumber" }, "is_return": { "type": "boolean", "description": "This field specifies if it is a scan-based return shipment. See the Create a return shipment section for more details." }, "lasership_attrs": { "description": "Specify Lasership Attributes (Lasership only). Multiple options accepted.", "items": { "$ref": "#/components/schemas/ShipmentExtraLasershipAttributesEnum" }, "type": "array" }, "lasership_declared_value": { "type": "string", "description": "Declared value (Lasership only). Defaults to `50.00`." }, "manifest_number": { "description": "UPS only. Adds custom manifest number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "model_number": { "description": "UPS only. Adds custom model number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "part_number": { "description": "UPS only. Adds custom part number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "po_number": { "$ref": "#/components/schemas/PoNumber" }, "preferred_delivery_timeframe": { "enum": [ "10001200", "12001400", "14001600", "16001800", "18002000", "19002100" ], "description": "Required for DHL Germany Paket Sameday. Designates a desired timeframe for delivery. Format is `HHMMHHMM`" }, "premium": { "type": "boolean", "description": "Add premium service to a shipment (DHL Germany international shipments only)." }, "production_code": { "description": "UPS only. Adds custom product code reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "purchase_request_number": { "description": "UPS only. Adds custom purchase request number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "qr_code_requested": { "type": "boolean", "description": "Request a QR code for a given transaction when creating a shipping label (USPS domestic and Evri UK only)." }, "reference_1": { "type": "string", "maxLength": 50, "description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 40 characters (Express services); Max 30 characters (Ground services) |" }, "reference_2": { "type": "string", "maxLength": 50, "description": "Optional text to be printed on the shipping label if supported by carrier. Up to 50 characters. For DHL eCommerce, this field can be used for billing reference.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |" }, "request_retail_rates": { "type": "boolean", "description": "Returns retail rates instead of account-based rates (UPS and FedEx only)." }, "return_service_type": { "type": "string", "description": "Request additional return option for return shipments (UPS and Lasership only).", "oneOf": [ { "$ref": "#/components/schemas/ShipmentExtraReturnServiceTypeUPSEnum" }, { "$ref": "#/components/schemas/ShipmentExtraReturnServiceTypeLasershipEnum" } ] }, "rma_number": { "$ref": "#/components/schemas/RmaNumber" }, "saturday_delivery": { "type": "boolean", "description": "Marks shipment as to be delivered on a Saturday." }, "salesperson_number": { "description": "UPS only. Adds custom salesperson number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "serial_number": { "description": "UPS only. Adds custom serial number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "signature_confirmation": { "enum": [ "STANDARD", "ADULT", "CERTIFIED", "INDIRECT", "CARRIER_CONFIRMATION" ], "description": "Request standard or adult signature confirmation. You can alternatively request Certified Mail (USPS only) \nor Indirect signature (FedEx only) or Carrier Confirmation (Deutsche Post only)." }, "store_number": { "description": "UPS only. Adds custom store number reference to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "transaction_reference_number": { "description": "UPS only. Adds custom transaction reference number to UPS labels.", "$ref": "#/components/schemas/UPSReferenceFields" }, "usmca_eligible": { "type": "boolean", "description": "UPS only. Request USMCA (United States-Mexico-Canada Agreement) preferential tariff treatment. \nWhen enabled, it includes the USMCA eligibility declaration in customs documentation.\n\nSupported routes and value limits:\n- USA/Canada → Mexico: ≤ $1,000 USD\n- Canada/Mexico → USA: ≤ $2,500 USD \n- USA/Mexico → Canada: ≤ $3,300 CAD\n\nOnly for declaration-only shipments, full USMCA - FormType 04 (Certificate of Origin) is not supported." } }, "type": "object" }, "ShipmentExtraReturnServiceTypeUPSEnum": { "type": "string", "enum": [ "PRINT_AND_MAIL", "ATTEMPT_1", "ATTEMPT_3", "ELECTRONIC_LABEL" ] }, "ShipmentExtraReturnServiceTypeLasershipEnum": { "type": "string", "enum": [ "NO_RETURN" ] }, "ShipmentExtraLasershipAttributesEnum": { "type": "string", "enum": [ "TwoPersonDelivery", "Explosive", "Alcohol", "Hazmat", "ControlledSubstance", "Refrigerated", "DryIce", "Perishable", "NoRTS" ] }, "UPSReferenceFields": { "properties": { "prefix": { "type": "string", "description": "Custom prefix text.", "example": "ABC" }, "value": { "type": "string", "description": "Label reference text. 35 character limit.", "example": "value" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 1 } } }, "ConnectExistingOwnAccountParameters": { "title": "Account parameters", "description": "An array of additional parameters for the account, such as e.g. password or token. Please check our \ncarrier accounts guide \nfor the parameters per carrier.\nTo protect account information, this field will be masked in any API response.\nIn the case of masked fields, they should be handled carefully.\n\nFields also must consider: \n- Not providing a *fields* in parameters will not result in a change to any configured value \n- Providing a value in a *masked field* with ****** (exactly 6 asterisks) will not change the configured value \n- Providing *field* with null will clear the configured value \n- Providing *field* with any other value will change the configured value and may affect the behavior of the account.\n", "additionalProperties": true }, "Insurance": { "description": "To add 3rd party insurance powered by XCover, \nspecify
`amount`, `content`, and `currency`.
Alternatively, you can choose carrier provided insurance \nby additionally specifying `provider` (UPS, FedEx and OnTrac only).

If you do not want to add insurance \nto your shipment, do not set these parameters.", "properties": { "amount": { "example": "5.5", "type": "string", "description": "Declared value of the goods you want to insure." }, "content": { "type": "string", "description": "Description of package content." }, "currency": { "example": "USD", "type": "string", "format": "iso-4217", "description": "Currency for the amount value.\nCurrently only USD is supported for FedEx and UPS." }, "provider": { "enum": [ "FEDEX", "UPS", "ONTRAC" ], "description": "To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set `provider` to `FEDEX`, `UPS`, or `ONTRAC`." } }, "type": "object" }, "InvoiceNumber": { "description": "Specify the invoice number field on the label (FedEx and UPS only).", "properties": { "prefix": { "type": "string", "description": "Custom prefix for invoice number field (ZPL labels only). Up to 11 characters, including trailing \nspaces. Empty string indicates removal of default prefix. To use the default prefix, do not include\nthis property." }, "value": { "type": "string", "maxLength": 40, "description": "Optional text to be printed on the shipping label for invoice number. Up to 40 characters. If\nprovided, this will be used on the label instead of shipment.customs_declaration.invoice.\n\n**Carrier-Specific Constraints:**\n| Carrier | Constraints |\n|:---|:---|\n| FedEx | Max 30 characters |" }, "ref_sort": { "type": "integer", "description": "Order UPS reference fields are printed on ZPL labels. For UPS shipments, if you choose to set `ref_sort` for one reference, you must set `ref_sort` for all other supported UPS references using unique integers.", "example": 2 } }, "type": "object" }, "LineItemBase": { "properties": { "currency": { "description": "Currency of the total_price amount.", "example": "USD", "type": "string" }, "manufacture_country": { "description": "Country the item was manufactured in. In the Shippo dashboard, this value will be used ot pre-fill the customs declaration when creating a label for this order.", "example": "US", "type": "string" }, "max_delivery_time": { "description": "The date and time this item needs to be delivered by, i.e. by when the carrier delivers it to the buyer. \nThis value is used by some platforms such as eBay to measure a seller's shipping time and performance. \nIt will be displayed in the Shippo dashboard.", "example": "2016-07-23T00:00:00Z", "format": "date-time", "type": "string" }, "max_ship_time": { "description": "The date and time this item needs to be fulfilled by, i.e. by when the shipping label needs to be \ncreated and handed over to the carrier. This value is used by some platforms such as eBay to measure \na seller's handling time and performance. It will be displayed in the Shippo dashboard.", "example": "2016-07-23T00:00:00Z", "format": "date-time", "type": "string" }, "quantity": { "description": "The quantity of this item in this order.", "example": 20, "format": "int64", "type": "integer" }, "sku": { "description": "The stock keeping unit value of this item.", "example": "HM-123", "type": "string" }, "title": { "description": "Title of the line item.", "example": "Hippo Magazines", "type": "string" }, "total_price": { "description": "Total price paid by the buyer for this item (or these items, if quantity > 1).", "example": "12.1", "type": "string" }, "variant_title": { "description": "A variant is a specific variation of an item (e.g. `size M` or `color blue`). \nVariants might be exposed as a separate resource in the future too. \nCurrently the variant title is a free text field describing the variant.", "example": "June Edition", "type": "string" }, "weight": { "description": "Total weight of this/these item(s). Instead of specifying the weight of all items, \nyou can also set the total_weight value of the order object.", "example": "0.4", "type": "string" }, "weight_unit": { "$ref": "#/components/schemas/WeightUnitEnum" } }, "type": "object" }, "LineItem": { "title": "Line Item", "x-tags": [ "Orders" ], "description": "

\n
Line Items, and their corresponding abstract Products and Variants, might be exposed as a separate resource\n in the future. Currently it's a nested object within the order resource.

\n

\nA line item is an individual object in an order. For example, if your order contains a t-shirt, shorts, and a jacket, each item is represented by a line item.", "allOf": [ { "$ref": "#/components/schemas/LineItemBase" }, { "properties": { "object_id": { "type": "string", "example": "abf7d5675d744b6ea9fdb6f796b28f28", "description": "Unique identifier of the line item object." } } } ] }, "LineItemCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/LineItemBase" } ] }, "LiveRateCreateRequest": { "properties": { "address_from": { "oneOf": [ { "type": "string", "description": "Object ID for an existing Address" }, { "$ref": "#/components/schemas/AddressCompleteCreateRequest" } ], "description": "The sender address, which includes your name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email." }, "address_to": { "oneOf": [ { "type": "string", "description": "Object ID for an existing Address" }, { "$ref": "#/components/schemas/AddressCompleteCreateRequest" } ], "description": "The recipient address, which includes the recipient's name, company name, street address, city, state, zip code, \ncountry, phone number, and email address (strings). Special characters should not be included in \nany address element, especially name, company, and email." }, "line_items": { "description": "Array of Line Item objects", "items": { "$ref": "#/components/schemas/LineItem" }, "type": "array" }, "parcel": { "oneOf": [ { "type": "string", "description": "Object ID for an existing User Parcel Template" }, { "$ref": "#/components/schemas/Parcel" } ], "description": "Object ID for an existing User Parcel Template OR a fully formed Parcel object.", "example": "5df144dca289442cv7a06" } }, "required": [ "address_to", "line_items" ], "type": "object" }, "Track": { "x-tags": [ "Tracking Status" ], "properties": { "address_from": { "$ref": "#/components/schemas/TrackingStatusFromLocation" }, "address_to": { "$ref": "#/components/schemas/TrackingStatusToLocation" }, "carrier": { "example": "usps", "type": "string", "description": "Name of the carrier of the shipment to track. See Carriers." }, "eta": { "format": "date-time", "type": "string", "description": "The estimated time of arrival according to the carrier, this might be updated by carriers during the life of the shipment." }, "messages": { "items": { "type": "string" }, "type": "array" }, "metadata": { "example": "Order 000123", "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object." }, "original_eta": { "example": "2021-07-23T00:00:00Z", "format": "date-time", "type": "string", "description": "The estimated time of arrival according to the carrier at the time the shipment first entered the system." }, "servicelevel": { "$ref": "#/components/schemas/ServiceLevelWithParent" }, "tracking_history": { "items": { "$ref": "#/components/schemas/TrackingStatus" }, "type": "array", "description": "A list of tracking events, following the same structure as tracking_status. \nIt contains a full history of all tracking statuses, starting with the earlier tracking event first." }, "tracking_number": { "example": "9205590164917312751089", "type": "string", "description": "Tracking number to track." }, "tracking_status": { "$ref": "#/components/schemas/TrackingStatus" }, "transaction": { "type": "string", "description": "The object_id of the transaction associated with this tracking object. \nThis field is visible only to the object owner of the transaction." } }, "required": [ "carrier", "tracking_number", "tracking_history", "messages" ], "type": "object" }, "TrackingStatus": { "description": "The latest tracking information of this shipment.", "properties": { "location": { "$ref": "#/components/schemas/TrackingStatusLocation" }, "object_created": { "format": "date-time", "type": "string" }, "object_id": { "type": "string" }, "object_updated": { "format": "date-time", "type": "string" }, "status": { "$ref": "#/components/schemas/TrackingStatusEnum" }, "substatus": { "$ref": "#/components/schemas/TrackingStatusSubstatus" }, "status_date": { "example": "2016-07-23T00:00:00Z", "format": "date-time", "type": "string", "description": "Date and time when the carrier scanned this tracking event. This is displayed in UTC." }, "status_details": { "example": "Your shipment has been delivered at the destination mailbox.", "type": "string", "description": "The human-readable description of the status." } }, "required": [ "object_created", "object_updated", "object_id", "status", "status_details" ], "type": "object" }, "TrackingStatusEnum": { "example": "DELIVERED", "type": "string", "description": "Indicates the high level status of the shipment.", "enum": [ "UNKNOWN", "PRE_TRANSIT", "TRANSIT", "DELIVERED", "RETURNED", "FAILURE" ] }, "TrackingStatusLocationBase": { "properties": { "city": { "example": "Las Vegas", "type": "string" }, "country": { "example": "US", "type": "string" }, "state": { "example": "NV", "type": "string" }, "zip": { "example": "89101", "type": "string" } }, "type": "object" }, "TrackingStatusLocation": { "allOf": [ { "$ref": "#/components/schemas/TrackingStatusLocationBase" } ], "description": "An object containing zip, city, state and country information of the tracking event." }, "TrackingStatusFromLocation": { "allOf": [ { "$ref": "#/components/schemas/TrackingStatusLocationBase" } ], "description": "The sender address with city, state, zip and country information." }, "TrackingStatusToLocation": { "allOf": [ { "$ref": "#/components/schemas/TrackingStatusLocationBase" } ], "description": "The recipient address with city, state, zip and country information." }, "TrackingStatusSubstatus": { "description": "A finer-grained classification of the tracking event.", "properties": { "code": { "example": "information_received", "type": "string", "description": "A code that represents the substatus of the shipment. See the Event Definitions for more information." }, "text": { "example": "Information about the package received.", "type": "string", "description": "A human-readable description of the substatus. See the Event Definitions for more information." }, "action_required": { "type": "boolean", "description": "Indicates whether the substatus requires action from the shipper or recipient to complete delivery." } }, "required": [ "code", "text", "action_required" ], "type": "object" }, "TracksRequest": { "properties": { "carrier": { "example": "usps", "type": "string", "description": "Name of the carrier of the shipment to track." }, "metadata": { "description": "A string of up to 100 characters that can be filled with any additional information you want to attach to the object.", "example": "Order 000123", "type": "string" }, "tracking_number": { "description": "Tracking number to track.", "example": "9205590164917312751089", "type": "string" } }, "required": [ "carrier", "tracking_number" ], "type": "object" }, "Transaction": { "x-tags": [ "Transactions" ], "properties": { "commercial_invoice_url": { "type": "string", "description": "A URL pointing to the commercial invoice as a 8.5x11 inch PDF file. \nA value will only be returned if the Transactions has been processed successfully and if the shipment is international." }, "created_by": { "anyOf": [ { "type": "object", "description": "An object with details about the user who created the Transaction (purchased the label).\nA value will be returned only for Transactions that can be associated with a specific user, e.g. when a logged-in\nuser purchases a label via the Shippo Web application; but not for Transactions purchased e.g. via the API using a ShippoToken,\nwhich is associated with the account but not any specific user.", "properties": { "first_name": { "type": "string", "example": "Shwan" }, "last_name": { "type": "string", "example": "Ippotle" }, "username": { "type": "string", "example": "shippotle@shippo.com" } } }, { "type": "null" } ] }, "eta": { "type": "string", "description": "The estimated time of arrival according to the carrier." }, "label_file_type": { "$ref": "#/components/schemas/LabelFileTypeEnum" }, "label_url": { "example": "https://shippo-delivery.s3.amazonaws.com/70ae8117ee1749e393f249d5b77c45e0.pdf?Signature=vDw1ltcyGveVR1OQoUDdzC43BY8%3D&Expires=1437093830&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "type": "string", "description": "A URL pointing directly to the label in the format you've set in your settings. \nA value will only be returned if the Transactions has been processed successfully." }, "messages": { "$ref": "#/components/schemas/ResponseMessageList" }, "metadata": { "type": "string", "description": "A string of up to 100 characters that can be filled with any additional information you want to \nattach to the object." }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Transaction creation." }, "object_id": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string", "description": "Unique identifier of the given Transaction object." }, "object_owner": { "example": "shippotle@shippo.com", "type": "string", "description": "Username of the user who created the Transaction object." }, "object_state": { "$ref": "#/components/schemas/ObjectStateEnum" }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last Transaction update." }, "parcel": { "example": "e94c7fdfdc7b495dbb390a28d929d90a", "type": "string", "description": "Object ID of the Parcel object that is being shipped." }, "qr_code_url": { "example": "https://shippo-delivery.s3.amazonaws.com/96_qr_code.pdf?Signature=PEdWrp0mFWAGwJp7FW3b%2FeA2eyY%3D&Expires=1385930652&AWSAccessKeyId=AKIAJTHP3LLFMYAWALIA", "type": "string", "description": "A URL pointing directly to the QR code in PNG format. \nA value will only be returned if requested using qr_code_requested flag and the carrier provides such an option." }, "rate": { "oneOf": [ { "$ref": "#/components/schemas/CoreRate" }, { "example": "ec9f0d3adc9441449c85d315f0997fd5", "type": "string" } ], "description": "ID of the Rate object for which a Label has to be obtained. \nIf you purchase a label by calling the transaction endpoint without a rate (instalabel), \nthis field will be a simplified Rate object in the Transaction model returned from the POST request.\n
Note, only rates less than 7 days old can be purchased to ensure up-to-date pricing." }, "status": { "$ref": "#/components/schemas/TransactionStatusEnum" }, "test": { "type": "boolean", "description": "Indicates whether the object has been created in test mode." }, "tracking_number": { "example": "9499907123456123456781", "type": "string", "description": "The carrier-specific tracking number that can be used to track the Shipment. \nA value will only be returned if the Rate is for a trackable Shipment and if the Transactions has been processed successfully." }, "tracking_status": { "$ref": "#/components/schemas/TrackingStatusEnum" }, "tracking_url_provider": { "example": "https://tools.usps.com/go/TrackConfirmAction_input?origTrackNum=9499907123456123456781", "type": "string", "description": "A link to track this item on the carrier-provided tracking website. \nA value will only be returned if tracking is available and the carrier provides such a service." } }, "type": "object" }, "TransactionStatusEnum": { "enum": [ "WAITING", "QUEUED", "SUCCESS", "ERROR", "REFUNDED", "REFUNDPENDING", "REFUNDREJECTED" ], "example": "SUCCESS", "type": "string", "description": "Indicates the status of the Transaction." }, "TransactionCreateRequest": { "title": "Create request to purchase label with a Rate", "properties": { "async": { "example": false, "type": "boolean", "default": true }, "label_file_type": { "$ref": "#/components/schemas/LabelFileTypeEnum" }, "metadata": { "example": "Order ID #12345", "type": "string" }, "rate": { "example": "ec9f0d3adc9441449c85d315f0997fd5", "type": "string" }, "order": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" } }, "required": [ "rate" ], "type": "object" }, "InstantTransactionCreateRequest": { "title": "Create request to purchase label without a Rate (Instalabel)", "properties": { "async": { "example": false, "type": "boolean", "default": false }, "carrier_account": { "example": "b741b99f95e841639b54272834bc478c", "type": "string" }, "label_file_type": { "example": "PDF", "type": "string", "enum": [ "PNG", "PNG_2.3x7.5", "PDF", "PDF_2.3x7.5", "PDF_4x6", "PDF_4x8", "PDF_A4", "PDF_A6", "ZPLII" ] }, "metadata": { "example": "Order ID #12345", "type": "string" }, "servicelevel_token": { "example": "usps_priority", "type": "string" }, "shipment": { "$ref": "#/components/schemas/ShipmentCreateRequest" }, "order": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" } }, "required": [ "shipment", "carrier_account", "servicelevel_token" ], "type": "object" }, "CoreRate": { "allOf": [ { "$ref": "#/components/schemas/RateAmountAndCurrency" }, { "properties": { "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string", "description": "Unique identifier of the Rate object." }, "provider": { "example": "USPS", "type": "string", "description": "Carrier offering the rate, e.g., `FedEx` or `Deutsche Post DHL`." }, "carrier_account": { "example": "078870331023437cb917f5187429b093", "type": "string", "description": "Object ID of the carrier account that has been used to retrieve the rate." }, "servicelevel_name": { "description": "Service level name, e.g. `Priority Mail` or `FedEx Ground®`. \nA service level commonly defines the transit time of a Shipment (e.g., Express vs. Standard), \nalong with other properties. These names vary depending on the provider.
\nSee Service Levels.", "example": "Priority Mail", "type": "string" }, "servicelevel_token": { "description": "Token of the Rate's servicelevel, e.g. `usps_priority` or `fedex_ground`.\nSee servicelevels.", "example": "fedex_ground", "type": "string" } } } ], "type": "object" }, "TransactionPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Transaction" }, "type": "array" } } } ] }, "Invoice": { "properties": { "object_id": { "example": "ec9f0d3adc9441449c85d315f0997fd5", "type": "string", "description": "Unique identifier of the given Invoice object" }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Invoice creation." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last Invoice update." }, "shippo_account": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string", "description": "Unique identifier of the user who the Invoice has been issued to." }, "invoice_number": { "example": 234167, "type": "string", "description": "Human readable unique identifier of the given Invoice object that is displayed in the web app." }, "status": { "$ref": "#/components/schemas/InvoiceStatusEnum" }, "invoice_closed": { "format": "date-time", "type": "string", "description": "Date and time of when the Invoice was posted and no new Invoice Items were added. Field will be null when invoice is still in the draft status." }, "invoice_paid_date": { "format": "date-time", "type": "string", "description": "Date and time of when the Invoice was successfully paid. Field will be null when invoice is not in the paid status." }, "total_invoiced": { "$ref": "#/components/schemas/AmountAndCurrencyInvoiced" }, "total_charged": { "$ref": "#/components/schemas/AmountAndCurrencyCharged" } }, "type": "object" }, "InvoicePaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/Invoice" }, "type": "array" } } } ] }, "InvoiceStatusEnum": { "enum": [ "DRAFT", "POSTED", "PAID", "UNCOLLECTIBLE", "VOID" ], "example": "POSTED", "type": "string", "description": "The status of the Invoice." }, "InvoiceItem": { "properties": { "object_id": { "example": "ec9f0d3adc9441449c85d315f0997fd5", "type": "string", "description": "Unique identifier of the given Invoice Item object." }, "object_created": { "format": "date-time", "type": "string", "description": "Date and time of Invoice Item creation." }, "object_updated": { "format": "date-time", "type": "string", "description": "Date and time of last Invoice Item update." }, "shippo_account": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string", "description": "Unique identifier of the user who the Invoice Item has been issued to." }, "type": { "$ref": "#/components/schemas/InvoiceItemTypesEnum", "example": "SUBSCRIPTION_PLAN_FEE", "type": "string" }, "description": { "example": "monthly subscription plan fee for 2019-08-24", "type": "string", "description": "Additional information about what the Invoice Item is for." }, "amount": { "example": "5.54", "type": "string", "description": "The money amount that the Invoice Item represents." }, "currency": { "example": "USD", "type": "string", "description": "The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. \"USD\" or \"EUR\".\nISO 4217 Standard." }, "charge_conversion": { "$ref": "#/components/schemas/ConversionAmount" }, "invoice": { "example": "011044d8405e43bd8b1efe1c21f967df", "type": "string", "description": "Unique identifier of the Invoice that the Invoice Item belongs to." }, "transaction": { "example": "915d94940ea54c3a80cbfa328722f5a1", "type": "string", "description": "Unique identifier of the Transaction that the Invoice Item represents. Not all Invoice Items are linked to a transaction." } }, "type": "object" }, "InvoiceItemTypesEnum": { "type": "string", "enum": [ "LABEL_PAYMENT", "LABEL_SURCHARGE", "LABEL_REFUND", "ONE_OFF_CREDIT", "TRACK_FEE", "ADDRESS_VALIDATION_FEE", "SUBSCRIPTION_PLAN_FEE", "PROMO_CODE_CREDIT", "PREAUTH_CAPTURE", "LABEL_PAYMENT_ADJUSTMENT", "LABEL_REFUND_ADJUSTMENT" ], "description": "The type of the Invoice Item.\n|Type| Description|\n|:---|:---|\n| LABEL_PAYMENT | Invoice Item for the payment of a label. |\n| LABEL_SURCHARGE | Invoice Item for a surcharge of a label. See here for more information. |\n| LABEL_REFUND | Invoice Item for a refund of a label. |\n| ONE_OFF_CREDIT | Invoice Item for credit given by Shippo. |\n| TRACK_FEE | Invoice Item for fees associated with tracking services. |\n| ADDRESS_VALIDATION_FEE | Invoice Item for fees associated with global address validation services. |\n| SUBSCRIPTION_PLAN_FEE | Invoice Item for subscription plan fees. |\n| PROMO_CODE_CREDIT | Invoice Item for promotional code related credits. |\n| PREAUTH_CAPTURE | Invoice Item for preauthorization capture. Represents a credit. See here for more information. |\n| LABEL_PAYMENT_ADJUSTMENT | Invoice Item for adjustments on label purchases. |\n| LABEL_REFUND_ADJUSTMENT | Invoice Item for adjustments on label refunds. |\n" }, "InvoiceItemPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/InvoiceItem" }, "type": "array" } } } ] }, "FedExConnectExistingOwnAccountParameters": { "title": "FedEx account parameters", "description": "In the case of masked fields, they should be handled carefully.\n\nFields also must consider: \n- Not providing a *fields* in parameters will not result in a change to any configured value \n- Providing a value in a *masked field* with ****** (exactly 6 asterisks) will not change the configured value \n- Providing *field* with null will clear the configured value \n- Providing *field* with any other value will change the configured value and may affect the behavior of the account.\n", "properties": { "first_name": { "type": "string", "description": "First name of the account holder" }, "last_name": { "type": "string", "description": "Last name of the account holder" }, "phone_number": { "type": "string", "description": "Phone number of the account holder" }, "from_address_st": { "type": "string", "description": "Street address of the account holder" }, "from_address_city": { "type": "string", "description": "City of the account holder" }, "from_address_state": { "type": "string", "description": "State of the account holder" }, "from_address_zip": { "type": "string", "description": "Zip code of the account holder" }, "from_address_country_iso2": { "type": "string", "format": "iso-3166-1-alpha-2", "description": "Country of the account holder" }, "use_multi_factor_registration": { "type": "boolean", "enum": [ true ], "description": "Must be true. FedEx accounts are registered using the multi-factor registration workflow." }, "verification_option": { "type": "string", "description": "Determines the verification option to use for the account registration (Enum: SMS, EMAIL, CALL, INVOICE).", "enum": [ "SMS", "EMAIL", "CALL", "INVOICE" ] }, "verification_pin": { "type": "string", "description": "(optional) The PIN to verify the account." }, "verification_invoice_number": { "type": "string", "description": "(optional) The invoice number to verify the account." }, "verification_invoice_amount": { "type": "string", "format": "decimal", "example": "340", "description": "(optional) The invoice amount to verify the account." }, "verification_invoice_date": { "type": "string", "format": "date", "pattern": "^\\d{4}-\\d{2}-\\d{2}$", "example": "2024-03-09", "description": "(optional) The invoice date to verify the account. In the format `YYYY-MM-DD`." }, "verification_invoice_currency": { "type": "string", "format": "iso-4217", "example": "USD", "description": "(optional) The invoice currency to verify the account." } }, "required": [ "first_name", "last_name", "phone_number", "from_address_st", "from_address_city", "from_address_state", "from_address_zip", "from_address_country_iso2", "use_multi_factor_registration", "verification_option" ], "type": "object" }, "UPSConnectExistingOwnAccountParameters": { "title": "UPS account parameters", "description": "An array of additional parameters for the account, such as e.g. password or token.\nPlease check the carrier accounts tutorial page for the parameters per carrier.
\nTo protect account information, this field will be masked in any API response.\nIn the case of masked fields, they should be handled carefully.\n\nFields also must consider: \n- Not providing a *fields* in parameters will not result in a change to any configured value \n- Providing a value in a *masked field* with ****** (exactly 6 asterisks) will not change the configured value \n- Providing *field* with null will clear the configured value \n- Providing *field* with any other value will change the configured value and may affect the behavior of the account.", "properties": { "account_number": { "description": "The UPS account number", "example": "94567e", "type": "string" }, "aia_country_iso2": { "description": "Only required if has_invoice is true. Country associated with the account that issued the invoice", "example": "US", "type": "string" }, "billing_address_city": { "example": "San Francisco", "type": "string" }, "billing_address_country_iso2": { "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_state": { "example": "CA", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_street1": { "example": "731 Market St", "type": "string" }, "billing_address_street2": { "description": "Empty string acceptable for billing_address_street2", "example": "STE 200", "type": "string" }, "billing_address_zip": { "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "collec_country_iso2": { "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "collec_zip": { "description": "Zip code of the collection/pickup address", "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "company": { "description": "Company name. Full name is acceptable in this field if the user has no company name", "example": "Shippo", "type": "string" }, "currency_code": { "description": "Only required if has_invoice is true. 3-letter currency code associated with invoice_value", "example": "USD", "maxLength": 3, "minLength": 3, "type": "string" }, "email": { "example": "hippo@shippo.com", "type": "string" }, "full_name": { "example": "Shippo Meister", "type": "string" }, "has_invoice": { "description": "true if user has been issued a UPS invoice within the past 90 days for the US or Canada; and 45 days for any other countries. User can use data from any of the last 3 invoices", "type": "boolean" }, "invoice_controlid": { "description": "Only required if aia_country_iso2 is US and has_invoice is true.", "example": "1234", "maxLength": 4, "minLength": 4, "type": "string" }, "invoice_date": { "description": "Only required if has_invoice is true. Date the invoice was issued. yyyymmdd format", "example": "20210529", "type": "string" }, "invoice_number": { "example": "1112234", "maxLength": 15, "minLength": 1, "type": "string" }, "invoice_value": { "description": "Only required if has_invoice is true. Max 16 digits before decimal and 2 digits after decimal", "example": "11.23", "type": "string" }, "phone": { "example": "1112223333", "type": "string" }, "title": { "description": "User's title, e.g. including but not limited to Manager, Doctor, Artist, Engineer, Mr, Ms, Mrs, Mx", "example": "Manager", "type": "string" }, "ups_agreements": { "description": "Whether the user agrees to the UPS terms and conditions or not. Error 400 will be returned if passed in as false", "type": "boolean" } }, "required": [ "ups_agreements", "account_number", "title", "company", "full_name", "phone", "billing_address_street1", "billing_address_city", "billing_address_zip", "billing_address_state", "billing_address_country_iso2", "collec_zip", "collec_country_iso2", "has_invoice", "email" ], "type": "object" }, "CreateNewOwnUPSAccountRequest": { "properties": { "account_id": { "description": "This field is required as input to the API, but is not used for UPS. Use the empty string.", "type": "string" }, "active": { "type": "boolean" }, "carrier": { "example": "ups", "type": "string" }, "metadata": { "example": "UPS Account", "type": "string" }, "parameters": { "$ref": "#/components/schemas/UPSCreateNewOwnAccountParameters" }, "test": { "example": false, "type": "boolean" } }, "required": [ "account_id", "parameters", "active" ], "type": "object" }, "UPSCreateNewOwnAccountParameters": { "properties": { "billing_address_city": { "example": "San Francisco", "type": "string" }, "billing_address_country_iso2": { "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_state": { "example": "CA", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_street1": { "example": "731 Market St", "type": "string" }, "billing_address_street2": { "description": "Empty string acceptable for billing_address_street2", "example": "STE 200", "type": "string" }, "billing_address_zip": { "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "company": { "description": "Company name. Full name is acceptable in this field if the user has no company name", "example": "Shippo", "type": "string" }, "email": { "example": "hippo@shippo.com", "type": "string" }, "full_name": { "example": "Shippo Meister", "type": "string" }, "phone": { "example": "1112223333", "type": "string" }, "pickup_address_city": { "description": "User's pickup address city. Only required if pickup_address_same_as_billing_address is false", "example": "San Francisco", "type": "string" }, "pickup_address_country_iso2": { "description": "User's pickup street 1. Only required if pickup_address_same_as_billing_address is false", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "pickup_address_same_as_billing_address": { "example": false, "type": "boolean" }, "pickup_address_state": { "description": "User's pickup address state. Only required if pickup_address_same_as_billing_address is false", "example": "CA", "maxLength": 2, "minLength": 2, "type": "string" }, "pickup_address_street1": { "description": "User's pickup address street 1. Only required if pickup_address_same_as_billing_address is false", "example": "731 Market St", "type": "string" }, "pickup_address_street2": { "description": "User's pickup street 2. Only used if pickup_address_same_as_billing_address is false, empty string acceptable", "example": "STE 200", "type": "string" }, "pickup_address_zip": { "description": "User's pickup address zip code. Only required if pickup_address_same_as_billing_address is false", "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "ups_agreements": { "description": "Whether the user agrees to the UPS terms and conditions or not. Error 400 will be returned if passed in as false", "type": "boolean" } }, "required": [ "ups_agreements", "email", "full_name", "company", "phone", "billing_address_street1", "billing_address_city", "billing_address_zip", "billing_address_state", "billing_address_country_iso2", "pickup_address_same_as_billing_address" ], "type": "object" }, "CarrierAccountBase": { "properties": { "account_id": { "description": "Unique identifier of the account. Please check the carrier accounts tutorial \npage for the `account_id` per carrier.
\nTo protect account information, this field will be masked in any API response.", "example": "****", "type": "string" }, "active": { "type": "boolean", "description": "Determines whether the account is active. When creating a shipment, if no `carrier_accounts` are explicitly \npassed Shippo will query all carrier accounts that have this field set. By default, this is set to True." }, "carrier": { "example": "usps", "type": "string", "description": "Carrier token, see Carriers
\nPlease check the carrier accounts tutorial page for all supported carriers." }, "parameters": { "oneOf": [ { "$ref": "#/components/schemas/ConnectExistingOwnAccountParameters" }, { "$ref": "#/components/schemas/FedExConnectExistingOwnAccountParameters" }, { "$ref": "#/components/schemas/UPSConnectExistingOwnAccountParameters" } ] } }, "required": [ "carrier", "account_id" ], "type": "object" }, "CarrierAccountWithExtraInfo": { "allOf": [ { "$ref": "#/components/schemas/CarrierAccount" }, { "properties": { "object_info": { "type": "object", "description": "Holds internal state relevant to users.", "properties": { "authentication": { "type": "object", "properties": { "type": { "type": "string", "description": "Authentication method used by this account.", "enum": [ "default", "oauth" ] }, "status": { "type": "string", "description": "Current authentication status. Possible values: 'disconnected' (authorization lost, reconnect needed), 'connected' (authorized and active), 'authorization_pending' (awaiting initial authorization flow).", "enum": [ "disconnected", "connected", "authorization_pending" ] } } }, "verification": { "type": "object", "properties": { "policy": { "type": "string", "description": "Policy to indicate if the Account needs multi-factor verification.", "enum": [ "required", "not-required" ] } } } } } } } ] }, "CarrierAccount": { "title": "Carrier Account", "x-tags": [ "Carrier Accounts" ], "allOf": [ { "$ref": "#/components/schemas/CarrierAccountBase" }, { "properties": { "carrier_name": { "example": "USPS", "description": "Carrier name, see Carriers
" }, "is_shippo_account": { "example": false, "type": "boolean" }, "metadata": { "type": "string" }, "object_id": { "example": "6aa34d5f6865448fbb1ee93636e98999", "type": "string", "description": "Unique identifier of the carrier account object." }, "object_owner": { "example": "bob+22@gmail.com", "type": "string", "description": "Username of the user who created the carrier account object." }, "service_levels": { "items": { "$ref": "#/components/schemas/CarrierAccountServiceLevel" }, "type": "array" }, "test": { "example": false, "type": "boolean", "description": "Indicates whether the object has been created in test mode." } } } ] }, "CarrierAccountServiceLevel": { "description": "Contains details regarding the service level for the carrier account.", "properties": { "name": { "example": "Priority Mail Express", "type": "string", "description": "Service level name, e.g. `Priority Mail` or `FedEx Ground®`. \nA service level commonly defines the transit time of a Shipment (e.g., Express vs. Standard), along with other properties. \nThese names vary depending on the provider.
\nSee Service Levels." }, "token": { "example": "usps_priority_express", "type": "string", "description": "Service level token, e.g. `usps_priority` or `fedex_ground`.
\nSee Service Levels." }, "supports_return_labels": { "example": true, "type": "boolean", "description": "Whether or not the service level supports return labels." } }, "type": "object" }, "CarrierAccountUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/CarrierAccountBase" } ] }, "CarrierAccountRegistrationStatus": { "properties": { "carrier_account": { "example": "99dc410d295b4a168993cc38809cb123", "type": "string" }, "object_created": { "format": "date-time", "type": "string" }, "object_owner": { "example": "tom@gmail.com", "type": "string" }, "object_updated": { "format": "date-time", "type": "string" }, "status": { "example": "PENDING_TERMS", "type": "string" } }, "type": "object" }, "CarrierAccountCanadaPostCreateRequest": { "title": "Shippo Canada Post account", "properties": { "carrier": { "type": "string", "const": "canada_post" }, "parameters": { "$ref": "#/components/schemas/CarrierAccountCanadaPostCreateParameters" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountCanadaPostCreateParameters": { "properties": { "canada_post_terms": { "description": "Whether or not the user agrees to Canada Post's terms. If passed in as false, request will fail with error 400", "type": "boolean" }, "company": { "example": "Shippo", "type": "string" }, "email": { "example": "hippo@shippo.com", "type": "string" }, "full_name": { "example": "Shippo Meister", "type": "string" }, "phone": { "description": "Needs to be a valid phone number and cannot be null", "example": "1112223333", "type": "string" } }, "required": [ "company", "phone", "full_name", "email", "canada_post_terms" ], "type": "object" }, "CarrierAccountChronopostCreateRequest": { "title": "Shippo Chronopost account", "properties": { "carrier": { "type": "string", "const": "chronopost" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountColissimoCreateRequest": { "title": "Shippo Colissimo account", "properties": { "carrier": { "type": "string", "const": "colissimo" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountCorreosCreateRequest": { "title": "Shippo Correos account", "properties": { "carrier": { "type": "string", "const": "correos" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountDeutschePostCreateRequest": { "title": "Shippo Deutsche Post account", "properties": { "carrier": { "type": "string", "const": "deutsche_post" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountDHLExpressCreateRequest": { "title": "Shippo DHL Express account", "properties": { "carrier": { "type": "string", "const": "dhl_express" }, "parameters": { "$ref": "#/components/schemas/CarrierAccountDHLExpressCreateRequestParameters" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountDHLExpressCreateRequestParameters": { "properties": { "user_accepted_terms_and_conditions": { "description": "Whether or not the user agrees to the DHL Express Terms and Conditions. If passed in as false, request will fail with error 400", "type": "boolean" } }, "required": [ "user_accepted_terms_and_conditions" ], "type": "object" }, "CarrierAccountDpdDeCreateRequest": { "title": "Shippo DPD DE account", "properties": { "carrier": { "type": "string", "const": "dpd_de" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountDPDUKCreateRequest": { "title": "Shippo DPD UK account", "properties": { "carrier": { "type": "string", "const": "dpd_uk" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountFedExCreateRequest": { "title": "Shippo FedEx account", "properties": { "carrier": { "type": "string", "const": "fedex" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountHermesUKCreateRequest": { "title": "Shippo Evri UK account", "properties": { "carrier": { "type": "string", "const": "hermes_uk" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountMondialRelayCreateRequest": { "title": "Shippo Mondial Relay account", "properties": { "carrier": { "type": "string", "const": "mondial_relay" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountPosteItalianeCreateRequest": { "title": "Shippo Poste Italiane account", "properties": { "carrier": { "type": "string", "const": "poste_italiane" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountUPSCreateRequest": { "title": "Shippo UPS account", "properties": { "carrier": { "type": "string", "const": "ups" }, "parameters": { "$ref": "#/components/schemas/CarrierAccountUPSCreateRequestParameters" } }, "required": [ "carrier" ], "type": "object" }, "CarrierAccountUSPSCreateRequest": { "title": "Shippo USPS account", "properties": { "carrier": { "const": "usps", "type": "string" }, "parameters": { "type": "object" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountRoyalMailCreateRequest": { "title": "Shippo Royal Mail account", "properties": { "carrier": { "type": "string", "const": "royal_mail" }, "parameters": { "$ref": "#/components/schemas/CarrierAccountRoyalMailCreateRequestParameters" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountRoyalMailSfCreateRequest": { "title": "Shippo Royal Mail Storefeeder account", "properties": { "carrier": { "type": "string", "const": "royal_mail_sf" }, "parameters": { "$ref": "#/components/schemas/CarrierAccountRoyalMailSfCreateRequestParameters" } }, "required": [ "carrier", "parameters" ], "type": "object" }, "CarrierAccountUPSCreateRequestParameters": { "properties": { "billing_address_city": { "example": "San Francisco", "type": "string" }, "billing_address_country_iso2": { "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_state": { "example": "CA", "maxLength": 2, "minLength": 2, "type": "string" }, "billing_address_street1": { "example": "731 Market St", "type": "string" }, "billing_address_street2": { "description": "Empty string acceptable for billing_address_street2", "example": "STE 200", "type": "string" }, "billing_address_zip": { "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "company": { "description": "Company name. Full name is acceptable in this field if the user has no company name", "example": "Shippo", "type": "string" }, "email": { "example": "hippo@shippo.com", "type": "string" }, "full_name": { "example": "Shippo Meister", "type": "string" }, "phone": { "description": "Needs to be a valid phone number and cannot be null", "example": "1112223333", "type": "string" }, "pickup_address_city": { "description": "User's pickup address city.", "example": "San Francisco", "type": "string" }, "pickup_address_country_iso2": { "description": "User's pickup street 1.", "example": "US", "maxLength": 2, "minLength": 2, "type": "string" }, "pickup_address_same_as_billing_address": { "example": false, "type": "boolean" }, "pickup_address_state": { "description": "User's pickup address state.", "example": "CA", "maxLength": 2, "minLength": 2, "type": "string" }, "pickup_address_street1": { "description": "User's pickup address street 1.", "example": "731 Market St", "type": "string" }, "pickup_address_street2": { "description": "User's pickup street 2.", "example": "STE 200", "type": "string" }, "pickup_address_zip": { "description": "User's pickup address zip code.", "example": "94103", "maxLength": 5, "minLength": 5, "type": "string" }, "ups_agreements": { "description": "Whether the user agrees to the UPS terms and conditions or not. Error 400 will be returned if passed in as false", "type": "boolean" } }, "required": [ "ups_agreements", "billing_address_street1", "billing_address_city", "billing_address_zip", "billing_address_state", "billing_address_country_iso2", "pickup_address_street1", "pickup_address_city", "pickup_address_zip", "pickup_address_state", "pickup_address_country_iso2" ], "type": "object" }, "CarrierAccountRoyalMailCreateRequestParameters": { "properties": { "client_id": { "description": "The client ID assigned to the user", "type": "string" }, "client_secret": { "description": "The secret that corresponds to the supplied client ID", "type": "string" }, "partner_token": { "description": "A unique identifier for your OBA account", "type": "string" } }, "required": [ "client_id", "client_secret", "partner_token" ] }, "CarrierAccountRoyalMailSfCreateRequestParameters": { "properties": { "royal_mail_sf_agreements": { "type": "boolean" } }, "required": [ "royal_mail_sf_agreements" ] }, "UserParcelTemplateBase": { "properties": { "distance_unit": { "$ref": "#/components/schemas/DistanceUnitEnum", "description": "The measure unit used for length, width and height. Required, but if using a preset carrier template then this field must be empty." }, "height": { "description": "The height of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.", "example": "6", "type": "string" }, "length": { "description": "The length of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.", "example": "10", "type": "string" }, "name": { "description": "The name of the User Parcel Template", "example": "My Custom Template", "type": "string" }, "weight": { "description": "The weight of the package, in units specified by the weight_unit attribute.", "example": "12", "type": "string" }, "weight_unit": { "$ref": "#/components/schemas/WeightUnitEnum" }, "width": { "description": "The width of the package, in units specified by the `distance_unit` attribute. Required, but if using a preset carrier template then this field must be empty.", "example": "8", "type": "string" } }, "type": "object" }, "UserParcelTemplateWithoutCarrierTemplateCreateRequest": { "allOf": [ { "$ref": "#/components/schemas/UserParcelTemplateBase" }, { "title": "A request to create or update a new parcel template.", "required": [ "name", "length", "width", "height", "distance_unit" ] } ] }, "UserParcelTemplateUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/UserParcelTemplateBase" }, { "required": [ "name", "length", "width", "height", "distance_unit" ] } ] }, "UserParcelTemplateWithCarrierTemplateCreateRequest": { "title": "A request to create or update a new parcel template.", "properties": { "template": { "description": "The object representing the carrier parcel template", "type": "string" }, "weight": { "description": "The weight of the package, in units specified by the weight_unit attribute.", "example": "12", "type": "string" }, "weight_unit": { "$ref": "#/components/schemas/WeightUnitEnum" } }, "type": "object" }, "UserParcelTemplateCreateRequest": { "oneOf": [ { "$ref": "#/components/schemas/UserParcelTemplateWithCarrierTemplateCreateRequest" }, { "$ref": "#/components/schemas/UserParcelTemplateWithoutCarrierTemplateCreateRequest" } ] }, "UserParcelTemplateList": { "properties": { "results": { "items": { "$ref": "#/components/schemas/UserParcelTemplate" }, "type": "array" } }, "type": "object" }, "UserParcelTemplate": { "title": "User Parcel Template", "x-tags": [ "User Parcel Templates" ], "allOf": [ { "$ref": "#/components/schemas/UserParcelTemplateBase" }, { "properties": { "object_created": { "description": "Date and time of User Parcel Template creation", "example": "2013-12-11T19:38:09.729Z", "format": "date-time", "type": "string" }, "object_id": { "description": "Unique identifier of the given User Parcel Template object", "example": "b958d3690bb04bb8b2986724872750f5", "type": "string" }, "object_owner": { "description": "Username of the user who created the User Parcel Template object", "example": "shippotle@shippo.com", "type": "string" }, "object_updated": { "description": "Date and time of last update on User Parcel Template", "example": "2013-12-12T19:38:09.729Z", "format": "date-time", "type": "string" }, "template": { "$ref": "#/components/schemas/CarrierParcelTemplate" } }, "title": "The fields of a parcel template before saving it to the db." } ] }, "WebhookBase": { "type": "object", "properties": { "event": { "type": "string", "description": "Type of event that triggers the webhook.", "example": "track_updated" }, "url": { "type": "string", "description": "URL webhook events are sent to.", "example": "https://example.com/shippo-webhook" }, "active": { "type": "boolean", "description": "Determines whether the webhook is active or not.", "example": true }, "is_test": { "type": "boolean", "description": "Determines whether the webhook is a test webhook or not.", "example": false } } }, "Webhook": { "x-tags": [ "Webhooks" ], "allOf": [ { "$ref": "#/components/schemas/WebhookBase" }, { "properties": { "object_created": { "type": "string", "format": "date-time", "description": "Timestamp of the creation of the webhook." }, "object_id": { "type": "string", "description": "Unique identifier of the webhook. This can be used to retrieve or delete the webhook." }, "object_updated": { "type": "string", "format": "date-time", "description": "Timestamp of the last update of the webhook." }, "object_owner": { "type": "string", "description": "Username of the user who created the webhook." } } } ], "required": [ "event", "url" ] }, "WebhookUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/WebhookBase" }, { "properties": { "event": { "$ref": "#/components/schemas/WebhookEventTypeEnum" } } } ], "required": [ "event", "url" ] }, "WebhookEventTypeEnum": { "description": "Type of event that triggered the webhook.", "type": "string", "enum": [ "transaction_created", "transaction_updated", "track_updated", "batch_created", "batch_purchased", "all" ] }, "WebhookPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "count": { "type": "integer" }, "results": { "type": "array", "items": { "$ref": "#/components/schemas/Webhook" } } } } ] }, "WebhookPayloadBase": { "description": "Content of the webhook posted to the external URL", "properties": { "event": { "$ref": "#/components/schemas/WebhookEventTypeEnum" }, "test": { "type": "boolean", "description": "Determines whether the webhook is a test webhook or not." } }, "type": "object" }, "WebhookPayloadTransaction": { "allOf": [ { "$ref": "#/components/schemas/WebhookPayloadBase" }, { "properties": { "data": { "$ref": "#/components/schemas/Transaction" } } } ], "type": "object" }, "WebhookPayloadBatch": { "allOf": [ { "$ref": "#/components/schemas/WebhookPayloadBase" }, { "properties": { "data": { "type": "string", "description": "A string containing the batch object ID, of the form 'batch {batchId} (created|processing complete)'." } } } ], "type": "object" }, "WebhookPayloadTrack": { "allOf": [ { "$ref": "#/components/schemas/WebhookPayloadBase" }, { "properties": { "data": { "$ref": "#/components/schemas/Track" } } } ] }, "WebhookPayload": { "title": "Webhook Payload", "x-tags": [ "Webhooks" ], "description": "The payload is the body of the POST request Shippo sends to the URL specified at the time of webhook registration.", "oneOf": [ { "$ref": "#/components/schemas/WebhookPayloadTrack" }, { "$ref": "#/components/schemas/WebhookPayloadBatch" }, { "$ref": "#/components/schemas/WebhookPayloadTransaction" } ], "discriminator": { "propertyName": "event", "mapping": { "track_updated": "#/components/schemas/WebhookPayloadTrack", "batch_created": "#/components/schemas/WebhookPayloadBatch", "batch_purchased": "#/components/schemas/WebhookPayloadBatch", "transaction_created": "#/components/schemas/WebhookPayloadTransaction", "transaction_updated": "#/components/schemas/WebhookPayloadTransaction" } }, "x-speakeasy-include": true }, "CarriersEnum": { "type": "string", "enum": [ "airterra", "apc_postal", "apg", "aramex", "asendia_us", "australia_post", "axlehire", "better_trucks", "borderguru", "boxberry", "bring", "canada_post", "cdl", "chronopost", "collect_plus", "correios_br", "correos_espana", "colissimo", "deutsche_post", "dhl_benelux", "dhl_ecommerce", "dhl_express", "dhl_germany_c2c", "dhl_germany", "dpd_de", "dpd_uk", "estafeta", "fastway_australia", "fedex", "globegistics", "gls_us", "gophr", "gso", "hermes_germany_b2c", "hermes_uk", "hongkong_post", "lasership", "lso", "mondial_relay", "new_zealand_post", "nippon_express", "ontrac", "parcelforce", "passport", "pcf", "poste_italiane", "posti", "purolator", "royal_mail", "royal_mail_sf", "rr_donnelley", "russian_post", "skypostal", "stuart", "swyft", "uds", "ups", "usps", "veho" ], "description": "|Token | Carrier name|\n|:---|:---|\n| airterra | Airterra |\n| apc_postal | APC Postal|\n| apg | APG|\n| aramex | Aramex|\n| asendia_us | Asendia US|\n| australia_post | Australia Post (also used for Startrack)|\n| axlehire | Jitsu|\n| better_trucks | BetterTrucks|\n| borderguru | BorderGuru|\n| boxberry | Boxberry|\n| bring | Bring (also used for Posten Norge)|\n| canada_post | Canada Post|\n| cdl | CDL|\n| chronopost | Chronopost|\n| collect_plus | CollectPlus|\n| correios_br | CorreiosBR|\n| correos_espana | Correos España |\n| colissimo | Colissimo|\n| deutsche_post | Deutsche Post|\n| dhl_benelux | DHL Benelux|\n| dhl_ecommerce | DHL eCommerce|\n| dhl_express | DHL Express|\n| dhl_germany_c2c | DHL Germany C2C|\n| dhl_germany | DHL Germany|\n| dpd_de | DPD GERMANY|\n| dpd_uk | DPD UK|\n| estafeta | Estafeta|\n| fastway_australia | Aramex|\n| fedex | FedEx|\n| globegistics | Globegistics (now Asendia)|\n| gls_us | GLS US|\n| gophr | Gophr|\n| gso | GSO|\n| hermes_germany_b2c | Hermes Germany B2C|\n| hermes_uk | Evri UK |\n| hongkong_post | Hongkong Post|\n| lasership | LaserShip|\n| lso | LSO|\n| mondial_relay | Mondial Relay|\n| new_zealand_post | New Zealand Post (also used for Pace and CourierPost)|\n| nippon_express | Nippon Express|\n| ontrac | OnTrac|\n| parcelforce | Parcelforce|\n| passport | Passport|\n| pcf | PCF|\n| poste_italiane | Poste Italiane |\n| posti | Posti|\n| purolator | Purolator|\n| royal_mail | Royal Mail|\n| royal_mail_sf | Royal Mail Storefeeder|\n| rr_donnelley | ePost Global|\n| russian_post | Russian Post|\n| skypostal | SkyPostal|\n| stuart | Stuart|\n| swyft | Swyft|\n| uds | UDS (United Delivery Service)|\n| ups | UPS|\n| usps | USPS|\n| veho | Veho |\n" }, "ObjectStateEnum": { "type": "string", "enum": [ "VALID", "INVALID" ], "description": "Indicates the validity of the enclosing object" }, "ServiceLevelUSPSEnum": { "type": "string", "enum": [ "usps_priority", "usps_priority_express", "usps_media_mail", "usps_priority_mail_international", "usps_priority_mail_express_international", "usps_first_class_package_international_service", "usps_ground_advantage" ], "description": "|Token | Service name|\n|:---|:---|\n| usps_priority | Priority Mail|\n| usps_priority_express | Priority Mail Express|\n| usps_media_mail | Media Mail, only for existing Shippo customers with grandfathered Media Mail option.|\n| usps_priority_mail_international | Priority Mail International|\n| usps_priority_mail_express_international | Priority Mail Express International|\n| usps_first_class_package_international_service | First Class Package International|\n| usps_ground_advantage | Ground Advantage |\n" }, "ServiceLevelFedExEnum": { "type": "string", "enum": [ "fedex_ground", "fedex_home_delivery", "fedex_smart_post", "fedex_ground_economy", "fedex_2_day", "fedex_2_day_am", "fedex_express_saver", "fedex_standard_overnight", "fedex_priority_overnight", "fedex_first_overnight", "fedex_international_economy", "fedex_international_priority", "fedex_international_first", "fedex_europe_first_international_priority", "fedex_international_connect_plus", "fedex_first", "fedex_priority", "fedex_priority_express", "fedex_economy_select", "fedex_regional_economy", "fedex_first_overnight_extra_hours", "fedex_international_priority_express", "fedex_next_day_mid_morning", "fedex_priority_overnight_extra_hours", "fedex_standard_overnight_extra_hours" ], "description": "|Token | Service name|\n|:---|:---|\n| fedex_ground | FedEx Ground®|\n| fedex_home_delivery | FedEx Home Delivery®|\n| fedex_ground_economy | FedEx Ground® Economy|\n| fedex_2_day | FedEx 2Day®|\n| fedex_2_day_am | FedEx 2Day® A.M.|\n| fedex_express_saver | FedEx Express Saver®|\n| fedex_standard_overnight | FedEx Standard Overnight®|\n| fedex_priority_overnight | FedEx Priority Overnight®|\n| fedex_first_overnight | FedEx First Overnight®|\n| fedex_international_economy | FedEx International Economy®|\n| fedex_international_priority | FedEx International Priority®|\n| fedex_international_first | FedEx International First®|\n| fedex_europe_first_international_priority | FedEx International First®|\n| fedex_international_connect_plus | FedEx International Connect Plus|\n| fedex_first | FedEx First |\n| fedex_priority | FedEx Priority |\n| fedex_priority_express | FedEx Priority Express|\n| fedex_economy_select | FedEx® Economy |\n| fedex_regional_economy | FedEx® Regional Economy |\n| fedex_first_overnight_extra_hours | First Overnight® EH |\n| fedex_international_priority_express | International Priority® Express |\n| fedex_next_day_mid_morning | Next Day Mid Morning |\n| fedex_priority_overnight_extra_hours | Priority Overnight® EH |\n| fedex_standard_overnight_extra_hours | Standard Overnight® EH |\n" }, "ServiceLevelUPSEnum": { "type": "string", "enum": [ "ups_standard", "ups_ground", "ups_saver", "ups_3_day_select", "ups_second_day_air", "ups_second_day_air_am", "ups_next_day_air", "ups_next_day_air_saver", "ups_next_day_air_early_am", "ups_mail_innovations_bpm_flat", "ups_mail_innovations_bpm_parcel", "ups_mail_innovations_irregular", "ups_mail_innovations_media_mail", "ups_mail_innovations_parcel", "ups_mail_innovations_standard_flat", "ups_surepost", "ups_surepost_bound_printed_matter", "ups_surepost_lightweight", "ups_surepost_media", "ups_express", "ups_express_1200", "ups_express_plus", "ups_expedited", "ups_express_early", "ups_access_point_economy" ], "description": "|Token | Service name|\n|:---|:---|\n| ups_standard | Standard℠|\n| ups_ground | Ground|\n| ups_saver | Saver®|\n| ups_3_day_select | 3 Day Select®|\n| ups_second_day_air | 2nd Day Air®|\n| ups_second_day_air_am | 2nd Day Air® A.M.|\n| ups_next_day_air | Next Day Air®|\n| ups_next_day_air_saver | Next Day Air Saver®|\n| ups_next_day_air_early_am | Next Day Air® Early|\n| ups_mail_innovations_bpm_flat | Mail Innovations BPM Flat |\n| ups_mail_innovations_bpm_parcel | Mail Innovations BPM Parcel |\n| ups_mail_innovations_irregular | Mail Innovations Irregular |\n| ups_mail_innovations_media_mail | Mail Innovations Media Mail |\n| ups_mail_innovations_parcel | Mail Innovations Parcel |\n| ups_mail_innovations_standard_flat | Mail Innovations Standard Flat |\n| ups_surepost | Surepost|\n| ups_surepost_bound_printed_matter | SurePost® Bound Printed Matter|\n| ups_surepost_lightweight | Surepost Lightweight|\n| ups_surepost_media | SurePost® Media|\n| ups_express | Express®|\n| ups_express_1200 | Express 12:00|\n| ups_express_plus | Express Plus®|\n| ups_expedited | Expedited®|\n| ups_express_early | Express® Early|\n| ups_access_point_economy | Access Point™ Economy|\n" }, "ServiceLevelAirterraEnum": { "type": "string", "enum": [ "airterra_ground", "airterra_postal" ], "description": "|Token | Service name|\n|:---|:---|\n| airterra_ground | GroundXC|\n| airterra_postal | FastPost|\n" }, "ServiceLevelSwyftEnum": { "type": "string", "enum": [ "same_day", "next_day" ], "description": "|Token | Service name|\n|:---|:---|\n| same_day | Next Day|\n| next_day | Next Day|\n" }, "ServiceLevelAPGEnum": { "type": "string", "enum": [ "epacket", "epacket_plus", "eparcel_premium", "apg_eparcel_expedited" ], "description": "|Token | Service name|\n|:---|:---|\n| epacket | ePacket|\n| epacket_plus | ePacket Plus|\n| eparcel_premium | eParcel premium|\n| apg_eparcel_expedited | eParcel Expedited|\n" }, "ServiceLevelUDSEnum": { "type": "string", "enum": [ "uds_next_day" ], "description": "|Token | Service name|\n|:---|:---|\n| uds_next_day | Next Day|\n" }, "ServiceLevelAPCPostalEnum": { "type": "string", "enum": [ "apc_postal_parcelconnect_expedited", "apc_postal_parcelconnect_priority", "apc_postal_parcelconnect_priority_delcon", "apc_postal_parcelconnect_priority_pqw", "apc_postal_parcelconnect_book_service", "apc_postal_parcelconnect_standard", "apc_postal_parcelconnect_epmi", "apc_postal_parcelconnect_epacket", "apc_postal_parcelconnect_epmei" ], "description": "|Token | Service name|\n|:---|:---|\n| apc_postal_parcelconnect_expedited | parcelConnect Expedited|\n| apc_postal_parcelconnect_priority | parcelConnect Priority|\n| apc_postal_parcelconnect_priority_delcon | parcelConnect Priority Delcon|\n| apc_postal_parcelconnect_priority_pqw | parcelConnect Priority PQW|\n| apc_postal_parcelconnect_book_service | parcelConnect Book Service|\n| apc_postal_parcelconnect_standard | parcelConnect Standard|\n| apc_postal_parcelconnect_epmi | parcelConnect ePMI|\n| apc_postal_parcelconnect_epacket | parcelConnect ePacket|\n| apc_postal_parcelconnect_epmei | parcelConnect ePMEI|\n" }, "ServiceLevelAsendiaEnum": { "type": "string", "enum": [ "asendia_us_priority_tracked", "asendia_us_international_express", "asendia_us_international_priority_airmail", "asendia_us_international_surface_airlift", "asendia_us_priority_mail_international", "asendia_us_priority_mail_express_international", "asendia_us_epacket", "asendia_us_other" ], "description": "|Token | Service name|\n|:---|:---|\n| asendia_us_priority_tracked | Asendia USA Priority Tracked|\n| asendia_us_international_express | Asendia USA International Express|\n| asendia_us_international_priority_airmail | Asendia USA International Priority Airmail|\n| asendia_us_international_surface_airlift | Asendia USA International Surface Air Lift|\n| asendia_us_priority_mail_international | Asendia USA Priority Mail International|\n| asendia_us_priority_mail_express_international | Asendia USA Priority Mail Express International|\n| asendia_us_epacket | Asendia USA International ePacket|\n| asendia_us_other | Asendia USA Other Services (custom)|\n" }, "ServiceLevelAustraliaPostEnum": { "type": "string", "enum": [ "australia_post_express_post", "australia_post_parcel_post", "australia_post_pack_and_track_international", "australia_post_international_airmail", "australia_post_express_post_international", "australia_post_express_courier_international", "australia_post_international_express", "australia_post_international_standard", "australia_post_international_economy", "australia_post_parcel_post_return" ], "description": "|Token | Service name|\n|:---|:---|\n| australia_post_express_post | Express Post|\n| australia_post_parcel_post | Parcel Post|\n| australia_post_pack_and_track_international | Pack and Track International|\n| australia_post_international_airmail | International Airmail|\n| australia_post_express_post_international | Express Post International|\n| australia_post_express_courier_international | Express Courier International|\n| australia_post_international_express | International Express|\n| australia_post_international_standard | International Standard|\n| australia_post_international_economy | International Economy|\n| australia_post_parcel_post_return | Parcel Post Return|\n" }, "ServiceLevelBetterTrucksEnum": { "type": "string", "enum": [ "better_trucks_same_day", "better_trucks_next_day" ], "description": "|Token | Service name|\n|:---|:---|\n| better_trucks_same_day | Same Day|\n| better_trucks_next_day | Next Day|\n" }, "ServiceLevelJitsuEnum": { "type": "string", "enum": [ "axlehire_same_day", "axlehire_next_day" ], "description": "|Token | Service name|\n|:---|:---|\n| axlehire_same_day | Same Day|\n| axlehire_next_day | Next Day|\n" }, "ServiceLevelCanadaPostEnum": { "type": "string", "enum": [ "canada_post_regular_parcel", "canada_post_expedited_parcel", "canada_post_priority", "canada_post_xpresspost", "canada_post_xpresspost_international", "canada_post_xpresspost_usa", "canada_post_expedited_parcel_usa", "canada_post_tracked_packet_usa", "canada_post_small_packet_usa_air", "canada_post_tracked_packet_international", "canada_post_small_packet_international_air", "canada_post_small_packet_international_surface", "canada_post_international_parcel_surface", "canada_post_international_parcel_air" ], "description": "|Token | Service name|\n|:---|:---|\n| canada_post_regular_parcel | Regular Parcel|\n| canada_post_expedited_parcel | Expedited Parcel|\n| canada_post_priority | Priority|\n| canada_post_xpresspost | Xpresspost|\n| canada_post_xpresspost_international | Xpresspost International|\n| canada_post_xpresspost_usa | Xpresspost USA|\n| canada_post_expedited_parcel_usa | Expedited Parcel USA|\n| canada_post_tracked_packet_usa | Tracked Packet USA|\n| canada_post_small_packet_usa_air | Small Packet USA Air|\n| canada_post_tracked_packet_international | Tracked Packet International|\n| canada_post_small_packet_international_air | Small Package International Air|\n| canada_post_small_packet_international_surface | Small Packet International Surface\n| canada_post_international_parcel_surface | International Parcel Surface\n| canada_post_international_parcel_air | International Parcel Air\n" }, "ServiceLevelCDLEnum": { "type": "string", "enum": [ "cdl_next_day" ], "description": "|Token | Service name|\n|:---|:---|\n| cdl_next_day | Next Day|\n" }, "ServiceLevelColissimoEnum": { "type": "string", "enum": [ "colissimo_home", "colissimo_pick_up_point", "colissimo_return_mainland_france" ], "description": "|Token | Service name|\n|:---|:---|\n| colissimo_home | Domicile|\n| colissimo_pick_up_point | Point Retrait|\n| colissimo_return_mainland_france | Retour France|\n" }, "ServiceLevelChronopostEnum": { "type": "string", "enum": [ "chronopost_13", "chronopost_10", "chronopost_18", "chronopost_relais_fr", "chronopost_classic", "chronopost_express" ], "description": "|Token | Service name|\n|:---|:---|\n| chronopost_13 | Chrono 13|\n| chronopost_10 | Chrono 10|\n| chronopost_18| Chrono 18|\n| chronopost_relais_fr | Chrono Point Relais|\n| chronopost_classic | Chrono Classic International|\n| chronopost_express | Chrono Express International|\n" }, "ServiceLevelCorreosEspanaEnum": { "type": "string", "enum": [ "correos_standard_home", "correos_premium_home" ], "description": "|Token | Service name|\n|:---|:---|\n| correos_standard_home| Paquete Estándar|\n| correos_premium_home | Paquete Premium|\n" }, "ServiceLevelPurolatorEnum": { "type": "string", "enum": [ "purolator_ground", "purolator_ground9_am", "purolator_ground1030_am", "purolator_ground_distribution", "purolator_ground_evening", "purolator_ground_us", "purolator_express", "purolator_express9_am", "purolator_express1030_am", "purolator_express_evening", "purolator_express_us", "purolator_express_us9_am", "purolator_express_us1030_am", "purolator_express_us1200", "purolator_express_international", "purolator_express_international9_am", "purolator_express_international1030_am", "purolator_express_international1200" ], "description": "|Token | Service name|\n|:---|:---|\n| purolator_ground | Ground|\n| purolator_ground9_am | Ground 9am|\n| purolator_ground1030_am | Ground 10:30am|\n| purolator_ground_distribution | Ground Distribution|\n| purolator_ground_evening | Ground Evening|\n| purolator_ground_us | Ground US|\n| purolator_express | Express|\n| purolator_express9_am | Express 9am|\n| purolator_express1030_am | Express 10am|\n| purolator_express_evening | Express Evening|\n| purolator_express_us | Express US|\n| purolator_express_us9_am | Express US 9am|\n| purolator_express_us1030_am | Express US 10:30am|\n| purolator_express_us1200 | Express US 12pm|\n| purolator_express_international | Express International|\n| purolator_express_international9_am | Express International 9am|\n| purolator_express_international1030_am | Express International 10:30am|\n| purolator_express_international1200 | Express International 12pm|\n" }, "ServiceLevelDHLExpressEnum": { "type": "string", "enum": [ "dhl_express_domestic_express_doc", "dhl_express_economy_select_doc", "dhl_express_worldwide_nondoc", "dhl_express_worldwide_doc", "dhl_express_worldwide", "dhl_express_worldwide_eu_doc", "dhl_express_break_bulk_express_doc", "dhl_express_express_9_00_nondoc", "dhl_express_economy_select_nondoc", "dhl_express_break_bulk_economy_doc", "dhl_express_express_9_00_doc", "dhl_express_express_10_30_doc", "dhl_express_express_10_30_nondoc", "dhl_express_express_12_00_doc", "dhl_express_europack_nondoc", "dhl_express_express_envelope_doc", "dhl_express_express_12_00_nondoc", "dhl_express_express_12_doc", "dhl_express_worldwide_b2c_doc", "dhl_express_worldwide_b2c_nondoc", "dhl_express_medical_express", "dhl_express_express_easy_nondoc" ], "description": "|Token | Service name|\n|:---|:---|\n| dhl_express_domestic_express_doc | Domestic Express Doc|\n| dhl_express_economy_select_doc | Economy Select Doc|\n| dhl_express_worldwide_nondoc | Express Worldwide Nondoc|\n| dhl_express_worldwide_doc | Express Worldwide Doc|\n| dhl_express_worldwide | Worldwide|\n| dhl_express_worldwide_eu_doc | Express Worldwide EU Doc|\n| dhl_express_break_bulk_express_doc | Break Bulk Express Doc|\n| dhl_express_express_9_00_nondoc | Express 9:00 NonDoc|\n| dhl_express_economy_select_nondoc | Economy Select NonDoc|\n| dhl_express_break_bulk_economy_doc | Break Bulk Economy Doc|\n| dhl_express_express_9_00_doc | Express 9:00 Doc|\n| dhl_express_express_10_30_doc | Express 10:30 Doc|\n| dhl_express_express_10_30_nondoc | Express 10:30 NonDoc|\n| dhl_express_express_12_00_doc | Express 12:00 Doc|\n| dhl_express_europack_nondoc | Europack NonDoc|\n| dhl_express_express_envelope_doc | Express Envelope Doc|\n| dhl_express_express_12_00_nondoc | Express 12:00 NonDoc|\n| dhl_express_express_12_doc | Domestic Express 12:00|\n| dhl_express_worldwide_b2c_doc | Express Worldwide (B2C) Doc|\n| dhl_express_worldwide_b2c_nondoc | Express Worldwide (B2C) NonDoc|\n| dhl_express_medical_express | Medical Express|\n| dhl_express_express_easy_nondoc | Express Easy NonDoc|\n" }, "ServiceLevelDHLeCommerceEnum": { "type": "string", "enum": [ "dhl_ecommerce_marketing_parcel_expedited", "dhl_ecommerce_globalmail_business_ipa", "dhl_ecommerce_parcel_international_direct", "dhl_ecommerce_parcels_expedited_max", "dhl_ecommerce_bpm_ground", "dhl_ecommerce_priority_expedited", "dhl_ecommerce_globalmail_packet_ipa", "dhl_ecommerce_globalmail_packet_isal", "dhl_ecommerce_easy_return_plus", "dhl_ecommerce_marketing_parcel_ground", "dhl_ecommerce_first_class_parcel_expedited", "dhl_ecommerce_globalmail_business_priority", "dhl_ecommerce_parcels_expedited", "dhl_ecommerce_globalmail_business_isal", "dhl_ecommerce_parcel_plus_expedited_max", "dhl_ecommerce_globalmail_packet_plus", "dhl_ecommerce_parcels_ground", "dhl_ecommerce_expedited", "dhl_ecommerce_parcel_plus_ground", "dhl_ecommerce_parcel_international_standard", "dhl_ecommerce_bpm_expedited", "dhl_ecommerce_parcel_international_expedited", "dhl_ecommerce_globalmail_packet_priority", "dhl_ecommerce_easy_return_light", "dhl_ecommerce_parcel_plus_expedited", "dhl_ecommerce_globalmail_business_standard", "dhl_ecommerce_ground", "dhl_ecommerce_globalmail_packet_standard" ], "description": "|Token | Service name|\n|:---|:---|\n| dhl_ecommerce_marketing_parcel_expedited | Marketing Parcel Expedited|\n| dhl_ecommerce_globalmail_business_ipa | GlobalMail Business IPA|\n| dhl_ecommerce_parcel_international_direct | Parcel International Direct|\n| dhl_ecommerce_parcels_expedited_max | Parcels Expedited Max|\n| dhl_ecommerce_bpm_ground | Bounded Printed Matter Ground|\n| dhl_ecommerce_priority_expedited | Priority Expedited|\n| dhl_ecommerce_globalmail_packet_ipa | GlobalMail Packet IPA|\n| dhl_ecommerce_globalmail_packet_isal | GlobalMail Packet ISAL|\n| dhl_ecommerce_easy_return_plus | Easy Return Plus|\n| dhl_ecommerce_marketing_parcel_ground | Marketing Parcel Ground|\n| dhl_ecommerce_first_class_parcel_expedited | First Class Parcel Expedited|\n| dhl_ecommerce_globalmail_business_priority | GlobalMail Business Priority|\n| dhl_ecommerce_parcels_expedited | Parcels Expedited|\n| dhl_ecommerce_globalmail_business_isal | GlobalMail Business ISAL|\n| dhl_ecommerce_parcel_plus_expedited_max | Parcel Plus Expedited Max|\n| dhl_ecommerce_globalmail_packet_plus | GlobalMail Packet Plus|\n| dhl_ecommerce_parcels_ground | Parcels Ground|\n| dhl_ecommerce_expedited | Expedited|\n| dhl_ecommerce_parcel_plus_ground | Parcel Plus Ground|\n| dhl_ecommerce_parcel_international_standard | Parcel International Standard|\n| dhl_ecommerce_bpm_expedited | Bounded Printed Matter Expedited|\n| dhl_ecommerce_parcel_international_expedited | Parcel International Expedited|\n| dhl_ecommerce_globalmail_packet_priority | GlobalMail Packet Priority|\n| dhl_ecommerce_easy_return_light | Easy Return Light|\n| dhl_ecommerce_parcel_plus_expedited | Parcel Plus Expedited|\n| dhl_ecommerce_globalmail_business_standard | GlobalMail Packet Standard|\n| dhl_ecommerce_ground | Ground|\n| dhl_ecommerce_globalmail_packet_standard | GlobalMail Business Standard|\n" }, "ServiceLevelDHLGermanyEnum": { "type": "string", "enum": [ "dhl_germany_europaket", "dhl_germany_paket", "dhl_germany_paket_connect", "dhl_germany_paket_international", "dhl_germany_paket_priority", "dhl_germany_paket_sameday" ], "description": "|Token | Service name|\n|:---|:---|\n| dhl_germany_europaket | DHL Germany Europaket|\n| dhl_germany_paket | DHL Germany Paket|\n| dhl_germany_paket_connect | DHL Germany Paket Connect|\n| dhl_germany_paket_international | DHL Germany Paket International|\n| dhl_germany_paket_priority | DHL Germany Paket Priority|\n| dhl_germany_paket_sameday | DHL Germany Paket Sameday|\n" }, "ServiceLevelDPDDEEnum": { "type": "string", "enum": [ "dpd_de_classic" ], "description": "|Token | Service name|\n|:---|:---|\n| dpd_de_classic | DPD Classic|\n" }, "ServiceLevelDPDUKEnum": { "type": "string", "enum": [ "dpd_uk_ship_to_shop", "dpd_uk_1030", "dpd_uk_1200", "dpd_uk_saturday", "dpd_uk_saturday_1030", "dpd_uk_saturday_1200", "dpd_uk_sunday", "dpd_uk_sunday_1030", "dpd_uk_sunday_1200", "dpd_uk_next_day", "dpd_uk_two_day", "dpd_uk_classic", "dpd_uk_air_classic", "dpd_uk_air_express", "dpd_uk_direct", "dpd_uk_direct_tracked_mail", "dpd_uk_pickup_returns" ], "description": "|Token | Service name|\n|:---|:---|\n| dpd_uk_ship_to_shop | Ship to shop|\n| dpd_uk_1030 | Door to door 10.30 next day|\n| dpd_uk_1200 | Door to door 12.00 next day|\n| dpd_uk_saturday | Saturday Delivery|\n| dpd_uk_saturday_1030 | Saturday Delivery 10.30|\n| dpd_uk_saturday_1200 | Saturday Delivery 12.00|\n| dpd_uk_sunday | Sunday Delivery|\n| dpd_uk_sunday_1030 | Sunday Delivery 10.30|\n| dpd_uk_sunday_1200 | Sunday Delivery 12.00|\n| dpd_uk_next_day | Next day|\n| dpd_uk_two_day | Two day|\n| dpd_uk_classic | DPD Classic|\n| dpd_uk_air_classic | DPD Air Classic|\n| dpd_uk_air_express | DPD Air Express|\n| dpd_uk_direct | DPD Direct|\n| dpd_uk_direct_tracked_mail| DPD Tracked Mail|\n| dpd_uk_pickup_returns | Pickup Returns|\n" }, "ServiceLevelDeutschePostEnum": { "type": "string", "enum": [ "deutsche_post_postkarte", "deutsche_post_standardbrief", "deutsche_post_kompaktbrief", "deutsche_post_grossbrief", "deutsche_post_maxibrief", "deutsche_post_maxibrief_plus", "deutsche_post_warenpost_international_xs", "deutsche_post_warenpost_international_s", "deutsche_post_warenpost_international_m", "deutsche_post_warenpost_international_l" ], "description": "|Token | Service name|\n|:---|:---|\n| deutsche_post_postkarte | Postkarte|\n| deutsche_post_standardbrief | Standardbrief|\n| deutsche_post_kompaktbrief | Kompaktbrief|\n| deutsche_post_grossbrief | Grossbrief|\n| deutsche_post_maxibrief | Maxibrief|\n| deutsche_post_maxibrief_plus | Maxibrief Plus|\n| deutsche_post_warenpost_international_xs | Warenpost International XS|\n| deutsche_post_warenpost_international_s | Warenpost International S|\n| deutsche_post_warenpost_international_m | Warenpost International M|\n| deutsche_post_warenpost_international_l | Warenpost International L|\n" }, "ServiceLevelAramexAustraliaEnum": { "type": "string", "enum": [ "fastway_australia_parcel", "fastway_australia_satchel", "fastway_australia_box_small", "fastway_australia_box_medium", "fastway_australia_box_large" ], "description": "|Token | Service name|\n|:---|:---|\n| fastway_australia_parcel | Parcel|\n| fastway_australia_satchel | Satchel|\n| fastway_australia_box_small | Box Small|\n| fastway_australia_box_medium | Box Medium|\n| fastway_australia_box_large | Box Large|\n" }, "ServiceLevelGlobegisticsEnum": { "type": "string", "enum": [ "globegistics_priority_mail_express_international", "globegistics_priority_mail_international", "globegistics_priority_mail_express_international_pds", "globegistics_priority_mail_international_pds", "globegistics_epacket", "globegistics_ecom_tracked_ddp", "globegistics_ecom_packet_ddp", "globegistics_ecom_priority_mail_international_ddp", "globegistics_ecom_priority_mail_express_international_ddp", "globegistics_ecom_extra", "globegistics_ecom_international_priority_airmail", "globegistics_ecom_international_surface_airlift" ], "description": "|Token | Service name|\n|:---|:---|\n| globegistics_priority_mail_express_international | Globegistics Priority Mail Express International|\n| globegistics_priority_mail_international | Globegistics Priority Mail International|\n| globegistics_priority_mail_express_international_pds | Globegistics Priority Mail Express International PreSort Drop Ship|\n| globegistics_priority_mail_international_pds | Globegistics Priority Mail International PreSort Drop Ship|\n| globegistics_epacket | Globegistics ePacket|\n| globegistics_ecom_tracked_ddp | Globegistics eCom Tracked DDP|\n| globegistics_ecom_packet_ddp | Globegistics eCom Packet DDP|\n| globegistics_ecom_priority_mail_international_ddp | Globegistics eCom Priority Mail International DDP|\n| globegistics_ecom_priority_mail_express_international_ddp | Globegistics eCom Priority Mail Express International DDP|\n| globegistics_ecom_extra | Globegistics eCom Extra|\n| globegistics_ecom_international_priority_airmail | Globegistics eCom International Priority Airmail|\n| globegistics_ecom_international_surface_airlift | Globegistics eCom International Surface Air Lift|\n" }, "ServiceLevelGLSUSEnum": { "type": "string", "enum": [ "gls_us_cps", "gls_us_eps", "gls_us_ess", "gls_us_nps", "gls_us_pds", "gls_us_sds" ], "description": "|Token | Service name|\n|:---|:---|\n| gls_us_cps | GSO Ground|\n| gls_us_eps | Early Priority Overnight|\n| gls_us_ess | Early Saturday Delivery|\n| gls_us_nps | Noon Priority Overnight|\n| gls_us_pds | Priority Overnight|\n| gls_us_sds | Saturday Delivery|\n" }, "ServiceLevelLSOEnum": { "type": "string", "enum": [ "lso_ground", "lso_economy_next_day", "lso_saturday_delivery", "lso_2nd_day", "lso_priority_next_day", "lso_early_overnight" ], "description": "|Token | Service name|\n|:---|:---|\n| lso_ground | Ground|\n| lso_economy_next_day | Economy Next Day|\n| lso_saturday_delivery | Saturday Delivery|\n| lso_2nd_day | 2nd Day|\n| lso_priority_next_day | Priority Next Day|\n| lso_early_overnight | Early Overnight|\n" }, "ServiceLevelMondialRelayEnum": { "type": "string", "enum": [ "mondial_relay_pointrelais" ], "description": "|Token | Service name|\n|:---|:---|\n| mondial_relay_pointrelais | Point Relais|\n" }, "ServiceLevelParcelforceEnum": { "type": "string", "enum": [ "parcelforce_express48", "parcelforce_express24", "parcelforce_expressam" ], "description": "|Token | Service name|\n|:---|:---|\n| parcelforce_express48 | Express 48|\n| parcelforce_express24 | Express 24|\n| parcelforce_expressam | Express AM|\n" }, "ServiceLevelPostItalianeEnum": { "type": "string", "enum": [ "poste_italiane_delivery_business_express" ], "description": "|Token | Service name|\n|:---|:---|\n| poste_italiane_delivery_business_express | Poste Delivery Business Express|\n" }, "ServiceLevelePostGlobalEnum": { "type": "string", "enum": [ "rr_donnelley_domestic_economy_parcel", "rr_donnelley_domestic_priority_parcel", "rr_donnelley_domestic_parcel_bpm", "rr_donnelley_priority_domestic_priority_parcel_bpm", "rr_donnelley_priority_parcel_delcon", "rr_donnelley_priority_parcel_nondelcon", "rr_donnelley_economy_parcel", "rr_donnelley_ipa", "rr_donnelley_courier", "rr_donnelley_isal", "rr_donnelley_epacket", "rr_donnelley_pmi", "rr_donnelley_emi" ], "description": "|Token | Service name|\n|:---|:---|\n| rr_donnelley_domestic_economy_parcel | Domestic Economy Parcel|\n| rr_donnelley_domestic_priority_parcel | Domestic Priority Parcel |\n| rr_donnelley_domestic_parcel_bpm | Domestic Parcel BPM|\n| rr_donnelley_priority_domestic_priority_parcel_bpm | Domestic Priority Parcel BPM|\n| rr_donnelley_priority_parcel_delcon | International Priority Parcel DelCon|\n| rr_donnelley_priority_parcel_nondelcon | International Priority Parcel NonDelcon|\n| rr_donnelley_economy_parcel | Economy Parcel Service |\n| rr_donnelley_ipa | International Priority Airmail (IPA)|\n| rr_donnelley_courier | International Courier|\n| rr_donnelley_isal | International Surface Air Lift (ISAL)|\n| rr_donnelley_epacket | e-Packet|\n| rr_donnelley_pmi | Priority Mail International|\n| rr_donnelley_emi | Express Mail International|\n" }, "ServiceLevelRoyalMailEnum": { "type": "string", "enum": [ "royal_mail_tracked_letter_boxable_24_no_signature", "royal_mail_tracked_letter_boxable_48_no_signature", "royal_mail_tracked_24_returns", "royal_mail_tracked_48_returns", "royal_mail_special_delivery_guaranteed_1pm", "royal_mail_special_delivery_guaranteed_9am", "royal_mail_24", "royal_mail_48", "royal_mail_signed_for_first_class", "royal_mail_signed_for_second_class", "royal_mail_standard_first_class", "royal_mail_standard_second_class", "royal_mail_tracked_24_no_signature", "royal_mail_tracked_48_no_signature", "royal_mail_intl_bus_mail_lrg_ltr_zone_sort_pri", "royal_mail_intl_bus_parcels_tracked_zone_sort", "royal_mail_intl_bus_parcels_tracked_country_priced", "royal_mail_intl_bus_parcels_tracked_signed_zone_srt", "royal_mail_24_flat_rate", "royal_mail_48_flat_rate" ], "description": "|Token | Service name|\n|:---|:---|\n| royal_mail_tracked_letter_boxable_24_no_signature | Royal Mail Tracked Letter-Boxable 24 No Signature|\n| royal_mail_tracked_letter_boxable_48_no_signature | Royal Mail Tracked Letter-Boxable 48 No Signature|\n| royal_mail_tracked_24_returns | Royal Mail Tracked Returns 24|\n| royal_mail_tracked_48_returns | Royal Mail Tracked Returns 48|\n| royal_mail_special_delivery_guaranteed_1pm | Special Delivery Guaranteed by 1pm\n| royal_mail_special_delivery_guaranteed_9am | Special Delivery Guaranteed by 9am\n| royal_mail_24 | RoyalMail 24\n| royal_mail_48 | RoyalMail 48\n| royal_mail_signed_for_first_class | Signed for First Class\n| royal_mail_signed_for_second_class | Signed for Second Class\n| royal_mail_standard_first_class | Standard First Class\n| royal_mail_standard_second_class | Standard Second Class\n| royal_mail_tracked_24_no_signature | Royal Mail Tracked 24 No Signature\n| royal_mail_tracked_48_no_signature | Royal Mail Tracked 48 No Signature\n| royal_mail_intl_bus_mail_lrg_ltr_zone_sort_pri | International Business Mail Large Letter Zone Sort Priority\n| royal_mail_intl_bus_parcels_tracked_zone_sort | International Business Parcels Tracked Zone Sort\n| royal_mail_intl_bus_parcels_tracked_country_priced | International Business Parcels Tracked Country Priced\n| royal_mail_intl_bus_parcels_tracked_signed_zone_srt | International Business Parcels & Signed Zone Sort\n| royal_mail_24_flat_rate | Royal Mail 24 Parcel Flat Rate\n| royal_mail_48_flat_rate | Royal Mail 48 Parcel Flat Rate\n" }, "ServiceLevelRoyalMailSFEnum": { "type": "string", "enum": [ "royal_mail_sf_tracked_48", "royal_mail_sf_tracked_48_for_post_office_drop", "royal_mail_sf_international_tracked", "royal_mail_sf_tracked_48_with_signature_confirmation", "royal_mail_sf_tracked_48_for_post_office_drop_with_signature_confirmation", "royal_mail_sf_tracked_24", "royal_mail_sf_tracked_24_for_post_office_drop", "royal_mail_sf_tracked_24_for_post_office_drop_with_signature_confirmation", "royal_mail_sf_international_tracked_for_post_office_drop", "royal_mail_sf_international_tracked_with_signature_confirmation", "royal_mail_sf_international_tracked_for_post_office_drop_with_signature_confirmation" ], "description": "|Token | Service name|\n|:---|:---|\n| royal_mail_sf_tracked_48 | Royal Mail Tracked 48|\n| royal_mail_sf_tracked_48_for_post_office_drop | Royal Mail Tracked 48 for Post Office Drop|\n| royal_mail_sf_international_tracked | Royal Mail International Tracked |\n| royal_mail_sf_tracked_48_with_signature_confirmation | Royal Mail Tracked 48 with Signature |\n| royal_mail_sf_tracked_48_for_post_office_drop_with_signature_confirmation | Royal Mail Tracked 48 for Post Office Drop with Signature |\n| royal_mail_sf_tracked_24 | Royal Mail Tracked 24 |\n| royal_mail_sf_tracked_24_for_post_office_drop | Royal Mail Tracked 24 for Post Office Drop |\n| royal_mail_sf_tracked_24_for_post_office_drop_with_signature_confirmation | Royal Mail Tracked 24 for Post Office Drop with Signature |\n| royal_mail_sf_international_tracked_for_post_office_drop | Royal Mail International Tracked for Post Office Drop |\n| royal_mail_sf_international_tracked_with_signature_confirmation | Royal Mail International Tracked with Signature |\n| royal_mail_sf_international_tracked_for_post_office_drop_with_signature_confirmation | Royal Mail International Tracked for Post Office Drop with Signature | \n" }, "ServiceLevelOnTracEnum": { "type": "string", "enum": [ "ontrac_ground", "ontrac_sunrise_gold", "ontrac_sunrise" ], "description": "|Token | Service name|\n|:---|:---|\n| ontrac_ground | Ground|\n| ontrac_sunrise_gold | Sunrise Gold|\n| ontrac_sunrise | Sunrise|\n" }, "ServiceLevelLasershipEnum": { "type": "string", "enum": [ "lasership_routed_delivery" ], "description": "|Token | Service name|\n|:---|:---|\n| lasership_routed_delivery | Routed Delivery|\n" }, "ServiceLevelVehoEnum": { "type": "string", "enum": [ "veho_ground_plus", "veho_premium_economy" ], "description": "|Token | Service name|\n|:---|:---|\n| veho_ground_plus | Veho Ground Plus |\n| veho_premium_economy | Veho Premium Economy\n" }, "ServiceLevelEvriUKEnum": { "type": "string", "enum": [ "hermes_uk_courier_service", "hermes_uk_parcelshop_dropoff", "hermes_uk_parcelshop_dropoff_nextday", "hermes_uk_postable", "hermes_uk_postable_nextday" ], "description": "|Token | Service name|\n|:---|:---|\n| hermes_uk_courier_service | Courier Collection|\n| hermes_uk_parcelshop_dropoff | ParcelShop Drop-Off|\n| hermes_uk_parcelshop_dropoff_nextday | ParcelShop Drop-Off Next Day|\n| hermes_uk_postable | Postable|\n| hermes_uk_postable_nextday | Postable Next Day|\n" }, "ServiceLevelEnumSet": { "oneOf": [ { "$ref": "#/components/schemas/ServiceLevelUSPSEnum" }, { "$ref": "#/components/schemas/ServiceLevelFedExEnum" }, { "$ref": "#/components/schemas/ServiceLevelUPSEnum" }, { "$ref": "#/components/schemas/ServiceLevelAirterraEnum" }, { "$ref": "#/components/schemas/ServiceLevelAPCPostalEnum" }, { "$ref": "#/components/schemas/ServiceLevelAsendiaEnum" }, { "$ref": "#/components/schemas/ServiceLevelAustraliaPostEnum" }, { "$ref": "#/components/schemas/ServiceLevelAPGEnum" }, { "$ref": "#/components/schemas/ServiceLevelBetterTrucksEnum" }, { "$ref": "#/components/schemas/ServiceLevelCanadaPostEnum" }, { "$ref": "#/components/schemas/ServiceLevelCDLEnum" }, { "$ref": "#/components/schemas/ServiceLevelChronopostEnum" }, { "$ref": "#/components/schemas/ServiceLevelCorreosEspanaEnum" }, { "$ref": "#/components/schemas/ServiceLevelColissimoEnum" }, { "$ref": "#/components/schemas/ServiceLevelPurolatorEnum" }, { "$ref": "#/components/schemas/ServiceLevelDHLExpressEnum" }, { "$ref": "#/components/schemas/ServiceLevelDHLeCommerceEnum" }, { "$ref": "#/components/schemas/ServiceLevelDHLGermanyEnum" }, { "$ref": "#/components/schemas/ServiceLevelDPDDEEnum" }, { "$ref": "#/components/schemas/ServiceLevelDPDUKEnum" }, { "$ref": "#/components/schemas/ServiceLevelDeutschePostEnum" }, { "$ref": "#/components/schemas/ServiceLevelAramexAustraliaEnum" }, { "$ref": "#/components/schemas/ServiceLevelGlobegisticsEnum" }, { "$ref": "#/components/schemas/ServiceLevelGLSUSEnum" }, { "$ref": "#/components/schemas/ServiceLevelLSOEnum" }, { "$ref": "#/components/schemas/ServiceLevelMondialRelayEnum" }, { "$ref": "#/components/schemas/ServiceLevelParcelforceEnum" }, { "$ref": "#/components/schemas/ServiceLevelPostItalianeEnum" }, { "$ref": "#/components/schemas/ServiceLevelePostGlobalEnum" }, { "$ref": "#/components/schemas/ServiceLevelRoyalMailEnum" }, { "$ref": "#/components/schemas/ServiceLevelRoyalMailSFEnum" }, { "$ref": "#/components/schemas/ServiceLevelOnTracEnum" }, { "$ref": "#/components/schemas/ServiceLevelJitsuEnum" }, { "$ref": "#/components/schemas/ServiceLevelLasershipEnum" }, { "$ref": "#/components/schemas/ServiceLevelEvriUKEnum" }, { "$ref": "#/components/schemas/ServiceLevelUDSEnum" }, { "$ref": "#/components/schemas/ServiceLevelVehoEnum" }, { "$ref": "#/components/schemas/ServiceLevelSwyftEnum" } ], "x-speakeasy-include": true }, "ParcelTemplateFedExEnum": { "type": "string", "title": "FedEx Parcel Template", "enum": [ "FedEx_Box_10kg", "FedEx_Box_25kg", "FedEx_Box_Extra_Large_1", "FedEx_Box_Extra_Large_2", "FedEx_Box_Large_1", "FedEx_Box_Large_2", "FedEx_Box_Medium_1", "FedEx_Box_Medium_2", "FedEx_Box_Small_1", "FedEx_Box_Small_2", "FedEx_Envelope", "FedEx_Padded_Pak", "FedEx_Pak_1", "FedEx_Pak_2", "FedEx_Tube", "FedEx_XL_Pak" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| FedEx_Box_10kg | FedEx® 10kg Box | 15.81 x 12.94 x 10.19 in|\n| FedEx_Box_25kg | FedEx® 25kg Box | 54.80 x 42.10 x 33.50 in|\n| FedEx_Box_Extra_Large_1 | FedEx® Extra Large Box (X1) | 11.88 x 11.00 x 10.75 in|\n| FedEx_Box_Extra_Large_2 | FedEx® Extra Large Box (X2) | 15.75 x 14.13 x 6.00 in|\n| FedEx_Box_Large_1 | FedEx® Large Box (L1) | 17.50 x 12.38 x 3.00 in|\n| FedEx_Box_Large_2 | FedEx® Large Box (L2) | 11.25 x 8.75 x 7.75 in|\n| FedEx_Box_Medium_1 | FedEx® Medium Box (M1) | 13.25 x 11.50 x 2.38 in|\n| FedEx_Box_Medium_2 | FedEx® Medium Box (M2) | 11.25 x 8.75 x 4.38 in|\n| FedEx_Box_Small_1 | FedEx® Small Box (S1) | 12.38 x 10.88 x 1.50 in|\n| FedEx_Box_Small_2 | FedEx® Small Box (S2) | 11.25 x 8.75 x 4.38 in|\n| FedEx_Envelope | FedEx® Envelope | 12.50 x 9.50 x 0.80 in|\n| FedEx_Padded_Pak | FedEx® Padded Pak | 11.75 x 14.75 x 2.00 in|\n| FedEx_Pak_1 | FedEx® Large Pak | 15.50 x 12.00 x 0.80 in|\n| FedEx_Pak_2 | FedEx® Small Pak | 12.75 x 10.25 x 0.80 in|\n| FedEx_Tube | FedEx® Tube | 38.00 x 6.00 x 6.00 in|\n| FedEx_XL_Pak | FedEx® Extra Large Pak | 17.50 x 20.75 x 2.00 in|\n" }, "ParcelTemplateUPSEnum": { "type": "string", "title": "UPS Parcel Template", "enum": [ "UPS_Box_10kg", "UPS_Box_25kg", "UPS_Express_Box", "UPS_Express_Box_Large", "UPS_Express_Box_Medium", "UPS_Express_Box_Small", "UPS_Express_Envelope", "UPS_Express_Hard_Pak", "UPS_Express_Legal_Envelope", "UPS_Express_Pak", "UPS_Express_Tube", "UPS_Laboratory_Pak", "UPS_MI_BPM", "UPS_MI_BPM_Flat", "UPS_MI_BPM_Parcel", "UPS_MI_First_Class", "UPS_MI_Flat", "UPS_MI_Irregular", "UPS_MI_Machinable", "UPS_MI_MEDIA_MAIL", "UPS_MI_Parcel_Post", "UPS_MI_Priority", "UPS_MI_Standard_Flat", "UPS_Pad_Pak", "UPS_Pallet" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| UPS_Box_10kg | Box 10kg | 410.00 x 335.00 x 265.00 mm|\n| UPS_Box_25kg | Box 25kg | 484.00 x 433.00 x 350.00 mm|\n| UPS_Express_Box | Express Box | 460.00 x 315.00 x 95.00 mm|\n| UPS_Express_Box_Large | Express Box Large | 18.00 x 13.00 x 3.00 in|\n| UPS_Express_Box_Medium | Express Box Medium | 15.00 x 11.00 x 3.00 in|\n| UPS_Express_Box_Small | Express Box Small | 13.00 x 11.00 x 2.00 in|\n| UPS_Express_Envelope | Express Envelope | 12.50 x 9.50 x 2.00 in|\n| UPS_Express_Hard_Pak | Express Hard Pak | 14.75 x 11.50 x 2.00 in|\n| UPS_Express_Legal_Envelope | Express Legal Envelope | 15.00 x 9.50 x 2.00 in|\n| UPS_Express_Pak | Express Pak | 16.00 x 12.75 x 2.00 in|\n| UPS_Express_Tube | Express Tube | 970.00 x 190.00 x 165.00 mm|\n| UPS_Laboratory_Pak | Laboratory Pak | 17.25 x 12.75 x 2.00 in|\n| UPS_MI_BPM | BPM (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_BPM_Flat | BPM Flat (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_BPM_Parcel | BPM Parcel (Mail Innovations - Domestic & International) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_First_Class | First Class (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Flat | Flat (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Irregular | Irregular (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Machinable | Machinable (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_MEDIA_MAIL | Media Mail (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Parcel_Post | Parcel Post (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Priority | Priority (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_MI_Standard_Flat | Standard Flat (Mail Innovations - Domestic only) | 0.00 x 0.00 x 0.00 in|\n| UPS_Pad_Pak | Pad Pak | 14.75 x 11.00 x 2.00 in|\n| UPS_Pallet | Pallet | 120.00 x 80.00 x 200.00 cm|\n" }, "ParcelTemplateUSPSEnum": { "type": "string", "title": "USPS Parcel Template", "enum": [ "USPS_FlatRateCardboardEnvelope", "USPS_FlatRateEnvelope", "USPS_FlatRateGiftCardEnvelope", "USPS_FlatRateLegalEnvelope", "USPS_FlatRatePaddedEnvelope", "USPS_FlatRateWindowEnvelope", "USPS_IrregularParcel", "USPS_LargeFlatRateBoardGameBox", "USPS_LargeFlatRateBox", "USPS_APOFlatRateBox", "USPS_LargeVideoFlatRateBox", "USPS_MediumFlatRateBox1", "USPS_MediumFlatRateBox2", "USPS_RegionalRateBoxA1", "USPS_RegionalRateBoxA2", "USPS_RegionalRateBoxB1", "USPS_RegionalRateBoxB2", "USPS_SmallFlatRateBox", "USPS_SmallFlatRateEnvelope", "USPS_SoftPack" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| USPS_FlatRateCardboardEnvelope | Flat Rate Cardboard Envelope | 12.50 x 9.50 x 0.75 in |\n| USPS_FlatRateEnvelope | Flat Rate Envelope | 12.50 x 9.50 x 0.75 in |\n| USPS_FlatRateGiftCardEnvelope | Flat Rate Gift Card Envelope | 10.00 x 7.00 x 0.75 in |\n| USPS_FlatRateLegalEnvelope | Flat Rate Legal Envelope | 15.00 x 9.50 x 0.75 in |\n| USPS_FlatRatePaddedEnvelope | Flat Rate Padded Envelope | 12.50 x 9.50 x 1.00 in |\n| USPS_FlatRateWindowEnvelope | Flat Rate Window Envelope | 10.00 x 5.00 x 0.75 in |\n| USPS_IrregularParcel | Irregular Parcel | 0.00 x 0.00 x 0.00 in |\n| USPS_LargeFlatRateBoardGameBox | Large Flat Rate Board Game Box | 24.06 x 11.88 x 3.13 in |\n| USPS_LargeFlatRateBox | Large Flat Rate Box | 12.25 x 12.25 x 6.00 in |\n| USPS_APOFlatRateBox | APO/FPO/DPO Large Flat Rate Box | 12.25 x 12.25 x 6.00 in |\n| USPS_LargeVideoFlatRateBox | Flat Rate Large Video Box (Int'l only) | 9.60 x 6.40 x 2.20 in |\n| USPS_MediumFlatRateBox1 | Medium Flat Rate Box 1 | 11.25 x 8.75 x 6.00 in |\n| USPS_MediumFlatRateBox2 | Medium Flat Rate Box 2 | 14.00 x 12.00 x 3.50 in |\n| USPS_RegionalRateBoxA1 | Regional Rate Box A1 | 10.13 x 7.13 x 5.00 in |\n| USPS_RegionalRateBoxA2 | Regional Rate Box A2 | 13.06 x 11.06 x 2.50 in |\n| USPS_RegionalRateBoxB1 | Regional Rate Box B1 | 12.25 x 10.50 x 5.50 in |\n| USPS_RegionalRateBoxB2 | Regional Rate Box B2 | 16.25 x 14.50 x 3.00 in |\n| USPS_SmallFlatRateBox | Small Flat Rate Box | 8.69 x 5.44 x 1.75 in |\n| USPS_SmallFlatRateEnvelope | Small Flat Rate Envelope | 10.00 x 6.00 x 4.00 in |\n| USPS_SoftPack | Soft Pack Padded Envelope | Length and width defined in the Parcel|\n" }, "ParcelTemplateDHLeCommerceEnum": { "type": "string", "title": "DHL eCommerce Parcel Template", "enum": [ "DHLeC_Irregular", "DHLeC_SM_Flats" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| DHLeC_Irregular | Irregular Shipment | 10.00 x 10.00 x 10.00 in|\n| DHLeC_SM_Flats | Flats | 27.00 x 17.00 x 17.00 in|\n" }, "ParcelTemplateDPDUKEnum": { "type": "string", "title": "DPD UK Parcel Template", "enum": [ "DPD_UK_Express_Pak" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| DPD_UK_Express_Pak| DPD UK Express Pak | 530.00 x 400.00 x 100.00 mm|\n" }, "ParcelTemplateAramexAustraliaEnum": { "type": "string", "title": "Aramex Australia Parcel Template", "enum": [ "Fastway_Australia_Satchel_A2", "Fastway_Australia_Satchel_A3", "Fastway_Australia_Satchel_A4", "Fastway_Australia_Satchel_A5" ], "description": "|Token | Name | Dimensions|\n|:---|:---|:---|\n| Fastway_Australia_Satchel_A2 | Satchel A2 | 594.00 x 420.00 x 48.00 mm|\n| Fastway_Australia_Satchel_A3 | Satchel A3 | 420.00 x 297.00 x 64.00 mm|\n| Fastway_Australia_Satchel_A4 | Satchel A4 | 297.00 x 210.00 x 64.00 mm|\n| Fastway_Australia_Satchel_A5 | Satchel A5 | 210.00 x 148.00 x 64.00 mm|\n" }, "ParcelTemplateEnumSet": { "description": "If template is passed, `length`, `width`, `height`, and `distance_unit` are not required", "oneOf": [ { "$ref": "#/components/schemas/ParcelTemplateFedExEnum" }, { "$ref": "#/components/schemas/ParcelTemplateUPSEnum" }, { "$ref": "#/components/schemas/ParcelTemplateUSPSEnum" }, { "$ref": "#/components/schemas/ParcelTemplateDHLeCommerceEnum" }, { "$ref": "#/components/schemas/ParcelTemplateDPDUKEnum" }, { "$ref": "#/components/schemas/ParcelTemplateAramexAustraliaEnum" } ], "x-speakeasy-include": true }, "LabelFileTypeEnum": { "description": "Print format of the label. If empty, will use the default format set from \nthe Shippo dashboard.", "enum": [ "PNG", "PNG_2.3x7.5", "PDF", "PDF_2.3x7.5", "PDF_4x6", "PDF_4x8", "PDF_A4", "PDF_A5", "PDF_A6", "ZPLII" ], "example": "PDF_4x6", "type": "string" }, "WeightUnitEnum": { "description": "The unit used for weight.", "enum": [ "g", "kg", "lb", "oz" ], "example": "lb", "type": "string" }, "DistanceUnitEnum": { "enum": [ "cm", "in", "ft", "m", "mm", "yd" ], "example": "in", "type": "string", "description": "The measure unit used for length, width and height." }, "ShippoAccountBase": { "properties": { "email": { "example": "hippo@shippo.com", "type": "string" }, "first_name": { "example": "Shippo", "type": "string" }, "last_name": { "example": "Meister", "type": "string" }, "company_name": { "example": "Acme", "type": "string" } }, "type": "object" }, "ShippoAccountUpdateRequest": { "allOf": [ { "$ref": "#/components/schemas/ShippoAccountBase" } ], "required": [ "first_name", "last_name", "email", "company_name" ], "title": "ShippoAccountUpdateRequest represents the fields of a shippo account before saving it to the db.", "type": "object" }, "ShippoAccount": { "title": "Shippo Account", "x-tags": [ "Shippo Accounts" ], "allOf": [ { "$ref": "#/components/schemas/ShippoAccountBase" }, { "properties": { "object_created": { "format": "date-time", "type": "string" }, "object_id": { "example": "adcfdddf8ec64b84ad22772bce3ea37a", "type": "string" }, "object_updated": { "format": "date-time", "type": "string" } } } ], "required": [ "first_name", "last_name", "email" ], "type": "object" }, "ShippoAccountPaginatedList": { "allOf": [ { "$ref": "#/components/schemas/PaginatedList" }, { "properties": { "results": { "items": { "$ref": "#/components/schemas/ShippoAccount" }, "type": "array" } } } ] } } }, "webhooks": { "batch": { "post": { "requestBody": { "description": "Batch created or purchased", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayloadBatch" } } } }, "responses": { "200": { "description": "The data was successfully received" } } } }, "track": { "post": { "requestBody": { "description": "Tracking status updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayloadTrack" } } } }, "responses": { "200": { "description": "The data was successfully received" } } } }, "transaction": { "post": { "requestBody": { "description": "Transaction created or updated", "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/WebhookPayloadTransaction" } } } }, "responses": { "200": { "description": "The data was successfully received" } } } } }, "x-speakeasy-globals": { "parameters": [ { "$ref": "#/components/parameters/ShippoApiVersionHeader" } ] }, "x-speakeasy-name-override": [ { "operationId": "^Create.*", "methodNameOverride": "create" }, { "operationId": "^Delete.*", "methodNameOverride": "delete" }, { "operationId": "^Get.*", "methodNameOverride": "get" }, { "operationId": "^List.*", "methodNameOverride": "list" }, { "operationId": "^Update.*", "methodNameOverride": "update" } ] }