mirror of
https://github.com/LukeHagar/speakeasy-playground.git
synced 2025-12-06 12:47:46 +00:00
generate sdk
This commit is contained in:
Mike Lueders
@@ -1,20 +1,42 @@
|
||||
lockVersion: 2.0.0
|
||||
id: f973dc21-d1bd-4e48-971a-a3918272099b
|
||||
management:
|
||||
docChecksum: 3851061474ad0b751f638e537d98fd25
|
||||
docVersion: "1"
|
||||
docChecksum: dc2d1900f0dc1be42cce4e7e4454f37a
|
||||
docVersion: "2018-02-08"
|
||||
speakeasyVersion: internal
|
||||
generationVersion: 2.275.2
|
||||
releaseVersion: 0.0.1
|
||||
configChecksum: 5be955b039369e57b218570e7f64d06f
|
||||
generationVersion: 2.276.1
|
||||
releaseVersion: 0.1.0
|
||||
configChecksum: bcb8bb4e68dd9bae2e5ddf046e490dd8
|
||||
features:
|
||||
python:
|
||||
constsAndDefaults: 0.1.2
|
||||
constsAndDefaults: 0.1.3
|
||||
core: 4.5.0
|
||||
flattening: 2.81.1
|
||||
globalSecurity: 2.83.4
|
||||
globalServerURLs: 2.82.1
|
||||
unions: 2.82.6
|
||||
generatedFiles:
|
||||
- src/shippo/sdkconfiguration.py
|
||||
- src/shippo/addresses.py
|
||||
- src/shippo/batches.py
|
||||
- src/shippo/carrier_accounts.py
|
||||
- src/shippo/customs_declarations.py
|
||||
- src/shippo/customs_items.py
|
||||
- src/shippo/invoices.py
|
||||
- src/shippo/rates_at_checkout.py
|
||||
- src/shippo/manifests.py
|
||||
- src/shippo/orders.py
|
||||
- src/shippo/carrier_parcel_templates.py
|
||||
- src/shippo/parcels.py
|
||||
- src/shippo/pickups.py
|
||||
- src/shippo/rates.py
|
||||
- src/shippo/refunds.py
|
||||
- src/shippo/service_groups.py
|
||||
- src/shippo/shipments.py
|
||||
- src/shippo/tracking_status.py
|
||||
- src/shippo/transactions.py
|
||||
- src/shippo/user_parcel_templates.py
|
||||
- src/shippo/shippo_accounts.py
|
||||
- src/shippo/sdk.py
|
||||
- pylintrc
|
||||
- setup.py
|
||||
@@ -24,13 +46,571 @@ generatedFiles:
|
||||
- src/shippo/utils/utils.py
|
||||
- src/shippo/models/errors/sdkerror.py
|
||||
- tests/helpers.py
|
||||
- src/shippo/models/operations/example.py
|
||||
- src/shippo/models/operations/listaddresses.py
|
||||
- src/shippo/models/operations/createaddress.py
|
||||
- src/shippo/models/operations/getaddress.py
|
||||
- src/shippo/models/operations/validateaddress.py
|
||||
- src/shippo/models/operations/createbatch.py
|
||||
- src/shippo/models/operations/getbatch.py
|
||||
- src/shippo/models/operations/addshipmentstobatch.py
|
||||
- src/shippo/models/operations/purchasebatch.py
|
||||
- src/shippo/models/operations/removeshipmentsfrombatch.py
|
||||
- src/shippo/models/operations/listcarrieraccounts.py
|
||||
- src/shippo/models/operations/createcarrieraccount.py
|
||||
- src/shippo/models/operations/getcarrieraccount.py
|
||||
- src/shippo/models/operations/updatecarrieraccount.py
|
||||
- src/shippo/models/operations/registercarrieraccount.py
|
||||
- src/shippo/models/operations/getcarrierregistrationstatus.py
|
||||
- src/shippo/models/operations/listcustomsdeclarations.py
|
||||
- src/shippo/models/operations/createcustomsdeclaration.py
|
||||
- src/shippo/models/operations/getcustomsdeclaration.py
|
||||
- src/shippo/models/operations/listcustomsitems.py
|
||||
- src/shippo/models/operations/createcustomsitem.py
|
||||
- src/shippo/models/operations/getcustomsitem.py
|
||||
- src/shippo/models/operations/getinvoice.py
|
||||
- src/shippo/models/operations/listinvoices.py
|
||||
- src/shippo/models/operations/listinvoiceitemstemplate.py
|
||||
- src/shippo/models/operations/createliverate.py
|
||||
- src/shippo/models/operations/getdefaultparceltemplate.py
|
||||
- src/shippo/models/operations/updatedefaultparceltemplate.py
|
||||
- src/shippo/models/operations/deletedefaultparceltemplate.py
|
||||
- src/shippo/models/operations/listmanifests.py
|
||||
- src/shippo/models/operations/createmanifest.py
|
||||
- src/shippo/models/operations/getmanifest.py
|
||||
- src/shippo/models/operations/listorders.py
|
||||
- src/shippo/models/operations/createorder.py
|
||||
- src/shippo/models/operations/getorder.py
|
||||
- src/shippo/models/operations/listcarrierparceltemplates.py
|
||||
- src/shippo/models/operations/getcarrierparceltemplate.py
|
||||
- src/shippo/models/operations/listparcels.py
|
||||
- src/shippo/models/operations/createparcel.py
|
||||
- src/shippo/models/operations/getparcel.py
|
||||
- src/shippo/models/operations/createpickup.py
|
||||
- src/shippo/models/operations/getrate.py
|
||||
- src/shippo/models/operations/listshipmentrates.py
|
||||
- src/shippo/models/operations/listshipmentratesbycurrencycode.py
|
||||
- src/shippo/models/operations/createrefund.py
|
||||
- src/shippo/models/operations/listrefund.py
|
||||
- src/shippo/models/operations/getrefund.py
|
||||
- src/shippo/models/operations/listservicegroups.py
|
||||
- src/shippo/models/operations/createservicegroup.py
|
||||
- src/shippo/models/operations/updateservicegroup.py
|
||||
- src/shippo/models/operations/deleteservicegroup.py
|
||||
- src/shippo/models/operations/listshipments.py
|
||||
- src/shippo/models/operations/createshipment.py
|
||||
- src/shippo/models/operations/getshipment.py
|
||||
- src/shippo/models/operations/createtrack.py
|
||||
- src/shippo/models/operations/gettrack.py
|
||||
- src/shippo/models/operations/listtransactions.py
|
||||
- src/shippo/models/operations/createtransaction.py
|
||||
- src/shippo/models/operations/gettransaction.py
|
||||
- src/shippo/models/operations/listuserparceltemplates.py
|
||||
- src/shippo/models/operations/createuserparceltemplate.py
|
||||
- src/shippo/models/operations/deleteuserparceltemplate.py
|
||||
- src/shippo/models/operations/getuserparceltemplate.py
|
||||
- src/shippo/models/operations/updateuserparceltemplate.py
|
||||
- src/shippo/models/operations/listshippoaccounts.py
|
||||
- src/shippo/models/operations/createshippoaccount.py
|
||||
- src/shippo/models/operations/getshippoaccount.py
|
||||
- src/shippo/models/operations/updateshippoaccount.py
|
||||
- src/shippo/models/components/addresslistwrapper.py
|
||||
- src/shippo/models/components/address.py
|
||||
- src/shippo/models/components/addressvalidationresults.py
|
||||
- src/shippo/models/components/addressvalidationresultsmessage.py
|
||||
- src/shippo/models/components/addresscreaterequest.py
|
||||
- src/shippo/models/components/batch.py
|
||||
- src/shippo/models/components/batchshipmentlistwrapper.py
|
||||
- src/shippo/models/components/batchshipment.py
|
||||
- src/shippo/models/components/errormessage.py
|
||||
- src/shippo/models/components/shipmentcreaterequest.py
|
||||
- src/shippo/models/components/parcelcreaterequest.py
|
||||
- src/shippo/models/components/parceltemplatefedex.py
|
||||
- src/shippo/models/components/parceltemplateups.py
|
||||
- src/shippo/models/components/parceltemplateusps.py
|
||||
- src/shippo/models/components/parceltemplatedhlecommerce.py
|
||||
- src/shippo/models/components/parceltemplatedpduk.py
|
||||
- src/shippo/models/components/parceltemplatecouriersplease.py
|
||||
- src/shippo/models/components/parceltemplatearamexaustralia.py
|
||||
- src/shippo/models/components/weightunit.py
|
||||
- src/shippo/models/components/distanceunittemplate.py
|
||||
- src/shippo/models/components/shipmentextra.py
|
||||
- src/shippo/models/components/rmanumber.py
|
||||
- src/shippo/models/components/ponumber.py
|
||||
- src/shippo/models/components/invoicenumber.py
|
||||
- src/shippo/models/components/insurance.py
|
||||
- src/shippo/models/components/dryice.py
|
||||
- src/shippo/models/components/departmentnumber.py
|
||||
- src/shippo/models/components/dangerousgoodsobject.py
|
||||
- src/shippo/models/components/dangerousgoodslithiumbatteries.py
|
||||
- src/shippo/models/components/dangerousgoodsbiologicalmaterial.py
|
||||
- src/shippo/models/components/customerreference.py
|
||||
- src/shippo/models/components/cod.py
|
||||
- src/shippo/models/components/billing.py
|
||||
- src/shippo/models/components/alcohol.py
|
||||
- src/shippo/models/components/labelfiletype.py
|
||||
- src/shippo/models/components/batchcreaterequest.py
|
||||
- src/shippo/models/components/batchshipmentbase.py
|
||||
- src/shippo/models/components/carrieraccountlistwrapper.py
|
||||
- src/shippo/models/components/carrieraccount.py
|
||||
- src/shippo/models/components/upsconnectexistingownaccountparameters.py
|
||||
- src/shippo/models/components/connectexistingownupsaccountrequest.py
|
||||
- src/shippo/models/components/carrieraccountbase.py
|
||||
- src/shippo/models/components/carrieraccountcanadapostcreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountcanadapostcreateparameters.py
|
||||
- src/shippo/models/components/carrieraccountchronopostcreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountcolissimocreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountcorreoscreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountdeutschepostcreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountdhlexpresscreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountdhlexpresscreaterequestparameters.py
|
||||
- src/shippo/models/components/carrieraccountdpddecreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountdpdukcreaterequest.py
|
||||
- src/shippo/models/components/carrieraccounthermesukcreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountposteitalianecreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountupscreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountupscreaterequestparameters.py
|
||||
- src/shippo/models/components/carrieraccountuspscreaterequest.py
|
||||
- src/shippo/models/components/carrieraccountregistrationstatus.py
|
||||
- src/shippo/models/components/customsdeclarationlistwrapper.py
|
||||
- src/shippo/models/components/customsdeclaration.py
|
||||
- src/shippo/models/components/objectstate.py
|
||||
- src/shippo/models/components/customsinvoicedcharges.py
|
||||
- src/shippo/models/components/customsexporteridentification.py
|
||||
- src/shippo/models/components/customstaxidentification.py
|
||||
- src/shippo/models/components/customsdeclarationcreaterequest.py
|
||||
- src/shippo/models/components/customsitembase.py
|
||||
- src/shippo/models/components/addressimporter.py
|
||||
- src/shippo/models/components/customsitemlistwrapper.py
|
||||
- src/shippo/models/components/customsitem.py
|
||||
- src/shippo/models/components/invoice.py
|
||||
- src/shippo/models/components/amountandcurrencycharged.py
|
||||
- src/shippo/models/components/amountandcurrencyinvoiced.py
|
||||
- src/shippo/models/components/invoicestatus.py
|
||||
- src/shippo/models/components/invoicelistwrapper.py
|
||||
- src/shippo/models/components/invoiceitemlistwrapper.py
|
||||
- src/shippo/models/components/invoiceitem.py
|
||||
- src/shippo/models/components/conversionamount.py
|
||||
- src/shippo/models/components/invoiceitemtypes.py
|
||||
- src/shippo/models/components/liveratelist.py
|
||||
- src/shippo/models/components/liverate.py
|
||||
- src/shippo/models/components/liveratecreaterequest.py
|
||||
- src/shippo/models/components/parcel.py
|
||||
- src/shippo/models/components/parcelextra.py
|
||||
- src/shippo/models/components/parcelinsurance.py
|
||||
- src/shippo/models/components/lineitem.py
|
||||
- src/shippo/models/components/addresscompletecreaterequest.py
|
||||
- src/shippo/models/components/defaultparceltemplate.py
|
||||
- src/shippo/models/components/userparceltemplate.py
|
||||
- src/shippo/models/components/carrierparceltemplatestruct.py
|
||||
- src/shippo/models/components/distanceunit.py
|
||||
- src/shippo/models/components/distanceunitusertemplate.py
|
||||
- src/shippo/models/components/defaultparceltemplateupdaterequest.py
|
||||
- src/shippo/models/components/manifestlistwrapper.py
|
||||
- src/shippo/models/components/manifest.py
|
||||
- src/shippo/models/components/manifestcreaterequest.py
|
||||
- src/shippo/models/components/orderlistwrapper.py
|
||||
- src/shippo/models/components/order.py
|
||||
- src/shippo/models/components/ordercreaterequest.py
|
||||
- src/shippo/models/components/lineitembase.py
|
||||
- src/shippo/models/components/carrierparceltemplatestructlistwrapper.py
|
||||
- src/shippo/models/components/parcellistwrapper.py
|
||||
- src/shippo/models/components/parcelrequest.py
|
||||
- src/shippo/models/components/pickup.py
|
||||
- src/shippo/models/components/location.py
|
||||
- src/shippo/models/components/pickupbase.py
|
||||
- src/shippo/models/components/rate.py
|
||||
- src/shippo/models/components/servicelevel.py
|
||||
- src/shippo/models/components/ratemessage.py
|
||||
- src/shippo/models/components/ratelistwrapper.py
|
||||
- src/shippo/models/components/refund.py
|
||||
- src/shippo/models/components/refundrequestbody.py
|
||||
- src/shippo/models/components/refundlistwrapper.py
|
||||
- src/shippo/models/components/servicegroup.py
|
||||
- src/shippo/models/components/servicegroupcreaterequest.py
|
||||
- src/shippo/models/components/shipmentlistwrapper.py
|
||||
- src/shippo/models/components/shipment.py
|
||||
- src/shippo/models/components/parceltemplate.py
|
||||
- src/shippo/models/components/track.py
|
||||
- src/shippo/models/components/trackingstatus.py
|
||||
- src/shippo/models/components/trackingstatussubstatus.py
|
||||
- src/shippo/models/components/trackingstatuslocationbase.py
|
||||
- src/shippo/models/components/tracksrequest.py
|
||||
- src/shippo/models/components/transactionlistwrapper.py
|
||||
- src/shippo/models/components/transaction.py
|
||||
- src/shippo/models/components/transactioncreaterequest.py
|
||||
- src/shippo/models/components/instanttransactionrequestbody.py
|
||||
- src/shippo/models/components/userparceltemplatelist.py
|
||||
- src/shippo/models/components/userparceltemplatewithcarriertemplatecreaterequest.py
|
||||
- src/shippo/models/components/userparceltemplatewithoutcarriertemplatecreaterequest.py
|
||||
- src/shippo/models/components/userparceltemplateupdaterequest.py
|
||||
- src/shippo/models/components/paginatedshippoaccountresponse.py
|
||||
- src/shippo/models/components/shippoaccount.py
|
||||
- src/shippo/models/components/baseshippoaccountstruct.py
|
||||
- src/shippo/models/components/security.py
|
||||
- src/shippo/models/errors/platformcarrierownaccountcreation400response.py
|
||||
- src/shippo/models/errors/carrieraccountregistrationstatus400response.py
|
||||
- src/shippo/models/errors/tracks400response.py
|
||||
- src/shippo/models/__init__.py
|
||||
- src/shippo/models/errors/__init__.py
|
||||
- src/shippo/models/operations/__init__.py
|
||||
- docs/models/operations/examplerequest.md
|
||||
- docs/models/operations/exampleresponse.md
|
||||
- src/shippo/models/components/__init__.py
|
||||
- docs/models/operations/listaddressesrequest.md
|
||||
- docs/models/operations/listaddressesresponse.md
|
||||
- docs/models/operations/createaddressrequest.md
|
||||
- docs/models/operations/createaddressresponse.md
|
||||
- docs/models/operations/getaddressrequest.md
|
||||
- docs/models/operations/getaddressresponse.md
|
||||
- docs/models/operations/validateaddressrequest.md
|
||||
- docs/models/operations/validateaddressresponse.md
|
||||
- docs/models/operations/createbatchrequest.md
|
||||
- docs/models/operations/createbatchresponse.md
|
||||
- docs/models/operations/getbatchrequest.md
|
||||
- docs/models/operations/getbatchresponse.md
|
||||
- docs/models/operations/addshipmentstobatchrequest.md
|
||||
- docs/models/operations/addshipmentstobatchresponse.md
|
||||
- docs/models/operations/purchasebatchrequest.md
|
||||
- docs/models/operations/purchasebatchresponse.md
|
||||
- docs/models/operations/removeshipmentsfrombatchrequest.md
|
||||
- docs/models/operations/removeshipmentsfrombatchresponse.md
|
||||
- docs/models/operations/listcarrieraccountsrequest.md
|
||||
- docs/models/operations/listcarrieraccountsresponse.md
|
||||
- docs/models/operations/createcarrieraccountrequest.md
|
||||
- docs/models/operations/createcarrieraccountresponse.md
|
||||
- docs/models/operations/getcarrieraccountrequest.md
|
||||
- docs/models/operations/getcarrieraccountresponse.md
|
||||
- docs/models/operations/updatecarrieraccountrequest.md
|
||||
- docs/models/operations/updatecarrieraccountresponse.md
|
||||
- docs/models/operations/registercarrieraccountrequestbody.md
|
||||
- docs/models/operations/registercarrieraccountrequest.md
|
||||
- docs/models/operations/registercarrieraccountresponse.md
|
||||
- docs/models/operations/carrier.md
|
||||
- docs/models/operations/getcarrierregistrationstatusrequest.md
|
||||
- docs/models/operations/getcarrierregistrationstatusresponse.md
|
||||
- docs/models/operations/listcustomsdeclarationsrequest.md
|
||||
- docs/models/operations/listcustomsdeclarationsresponse.md
|
||||
- docs/models/operations/createcustomsdeclarationrequest.md
|
||||
- docs/models/operations/createcustomsdeclarationresponse.md
|
||||
- docs/models/operations/getcustomsdeclarationrequest.md
|
||||
- docs/models/operations/getcustomsdeclarationresponse.md
|
||||
- docs/models/operations/listcustomsitemsrequest.md
|
||||
- docs/models/operations/listcustomsitemsresponse.md
|
||||
- docs/models/operations/createcustomsitemrequest.md
|
||||
- docs/models/operations/createcustomsitemresponse.md
|
||||
- docs/models/operations/getcustomsitemrequest.md
|
||||
- docs/models/operations/getcustomsitemresponse.md
|
||||
- docs/models/operations/getinvoicerequest.md
|
||||
- docs/models/operations/getinvoiceresponse.md
|
||||
- docs/models/operations/listinvoicesrequest.md
|
||||
- docs/models/operations/listinvoicesresponse.md
|
||||
- docs/models/operations/listinvoiceitemstemplaterequest.md
|
||||
- docs/models/operations/listinvoiceitemstemplateresponse.md
|
||||
- docs/models/operations/createliveraterequest.md
|
||||
- docs/models/operations/createliverateresponse.md
|
||||
- docs/models/operations/getdefaultparceltemplaterequest.md
|
||||
- docs/models/operations/getdefaultparceltemplateresponse.md
|
||||
- docs/models/operations/updatedefaultparceltemplaterequest.md
|
||||
- docs/models/operations/updatedefaultparceltemplateresponse.md
|
||||
- docs/models/operations/deletedefaultparceltemplaterequest.md
|
||||
- docs/models/operations/deletedefaultparceltemplateresponse.md
|
||||
- docs/models/operations/listmanifestsrequest.md
|
||||
- docs/models/operations/listmanifestsresponse.md
|
||||
- docs/models/operations/createmanifestrequest.md
|
||||
- docs/models/operations/createmanifestresponse.md
|
||||
- docs/models/operations/getmanifestrequest.md
|
||||
- docs/models/operations/getmanifestresponse.md
|
||||
- docs/models/operations/listordersrequest.md
|
||||
- docs/models/operations/listordersresponse.md
|
||||
- docs/models/operations/createorderrequest.md
|
||||
- docs/models/operations/createorderresponse.md
|
||||
- docs/models/operations/getorderrequest.md
|
||||
- docs/models/operations/getorderresponse.md
|
||||
- docs/models/operations/include.md
|
||||
- docs/models/operations/listcarrierparceltemplatesrequest.md
|
||||
- docs/models/operations/listcarrierparceltemplatesresponse.md
|
||||
- docs/models/operations/getcarrierparceltemplaterequest.md
|
||||
- docs/models/operations/getcarrierparceltemplateresponse.md
|
||||
- docs/models/operations/listparcelsrequest.md
|
||||
- docs/models/operations/listparcelsresponse.md
|
||||
- docs/models/operations/createparcelrequest.md
|
||||
- docs/models/operations/createparcelresponse.md
|
||||
- docs/models/operations/getparcelrequest.md
|
||||
- docs/models/operations/getparcelresponse.md
|
||||
- docs/models/operations/createpickuprequest.md
|
||||
- docs/models/operations/createpickupresponse.md
|
||||
- docs/models/operations/getraterequest.md
|
||||
- docs/models/operations/getrateresponse.md
|
||||
- docs/models/operations/listshipmentratesrequest.md
|
||||
- docs/models/operations/listshipmentratesresponse.md
|
||||
- docs/models/operations/listshipmentratesbycurrencycoderequest.md
|
||||
- docs/models/operations/listshipmentratesbycurrencycoderesponse.md
|
||||
- docs/models/operations/createrefundrequest.md
|
||||
- docs/models/operations/createrefundresponse.md
|
||||
- docs/models/operations/listrefundrequest.md
|
||||
- docs/models/operations/listrefundresponse.md
|
||||
- docs/models/operations/getrefundrequest.md
|
||||
- docs/models/operations/getrefundresponse.md
|
||||
- docs/models/operations/listservicegroupsrequest.md
|
||||
- docs/models/operations/listservicegroupsresponse.md
|
||||
- docs/models/operations/createservicegrouprequest.md
|
||||
- docs/models/operations/createservicegroupresponse.md
|
||||
- docs/models/operations/updateservicegrouprequest.md
|
||||
- docs/models/operations/updateservicegroupresponse.md
|
||||
- docs/models/operations/deleteservicegrouprequest.md
|
||||
- docs/models/operations/deleteservicegroupresponse.md
|
||||
- docs/models/operations/listshipmentsrequest.md
|
||||
- docs/models/operations/listshipmentsresponse.md
|
||||
- docs/models/operations/createshipmentrequest.md
|
||||
- docs/models/operations/createshipmentresponse.md
|
||||
- docs/models/operations/getshipmentrequest.md
|
||||
- docs/models/operations/getshipmentresponse.md
|
||||
- docs/models/operations/createtrackrequest.md
|
||||
- docs/models/operations/createtrackresponse.md
|
||||
- docs/models/operations/gettrackrequest.md
|
||||
- docs/models/operations/gettrackresponse.md
|
||||
- docs/models/operations/listtransactionsrequest.md
|
||||
- docs/models/operations/listtransactionsresponse.md
|
||||
- docs/models/operations/createtransactionrequestbody.md
|
||||
- docs/models/operations/createtransactionrequest.md
|
||||
- docs/models/operations/createtransactionresponse.md
|
||||
- docs/models/operations/gettransactionrequest.md
|
||||
- docs/models/operations/gettransactionresponse.md
|
||||
- docs/models/operations/listuserparceltemplatesrequest.md
|
||||
- docs/models/operations/listuserparceltemplatesresponse.md
|
||||
- docs/models/operations/createuserparceltemplaterequest.md
|
||||
- docs/models/operations/createuserparceltemplateresponse.md
|
||||
- docs/models/operations/deleteuserparceltemplaterequest.md
|
||||
- docs/models/operations/deleteuserparceltemplateresponse.md
|
||||
- docs/models/operations/getuserparceltemplaterequest.md
|
||||
- docs/models/operations/getuserparceltemplateresponse.md
|
||||
- docs/models/operations/updateuserparceltemplaterequest.md
|
||||
- docs/models/operations/updateuserparceltemplateresponse.md
|
||||
- docs/models/operations/listshippoaccountsrequest.md
|
||||
- docs/models/operations/listshippoaccountsresponse.md
|
||||
- docs/models/operations/createshippoaccountrequest.md
|
||||
- docs/models/operations/createshippoaccountresponse.md
|
||||
- docs/models/operations/getshippoaccountrequest.md
|
||||
- docs/models/operations/getshippoaccountresponse.md
|
||||
- docs/models/operations/updateshippoaccountrequest.md
|
||||
- docs/models/operations/updateshippoaccountresponse.md
|
||||
- docs/models/components/addresslistwrapper.md
|
||||
- docs/models/components/address.md
|
||||
- docs/models/components/addressvalidationresults.md
|
||||
- docs/models/components/code.md
|
||||
- docs/models/components/source.md
|
||||
- docs/models/components/addressvalidationresultsmessage.md
|
||||
- docs/models/components/addresscreaterequest.md
|
||||
- docs/models/components/objectresults.md
|
||||
- docs/models/components/batchstatus.md
|
||||
- docs/models/components/batch.md
|
||||
- docs/models/components/batchshipmentlistwrapper.md
|
||||
- docs/models/components/status.md
|
||||
- docs/models/components/batchshipment.md
|
||||
- docs/models/components/errormessage.md
|
||||
- docs/models/components/shipmentcreaterequest.md
|
||||
- docs/models/components/parcelcreaterequest.md
|
||||
- docs/models/components/parceltemplateenumset.md
|
||||
- docs/models/components/parceltemplatefedex.md
|
||||
- docs/models/components/parceltemplateups.md
|
||||
- docs/models/components/parceltemplateusps.md
|
||||
- docs/models/components/parceltemplatedhlecommerce.md
|
||||
- docs/models/components/parceltemplatedpduk.md
|
||||
- docs/models/components/parceltemplatecouriersplease.md
|
||||
- docs/models/components/parceltemplatearamexaustralia.md
|
||||
- docs/models/components/weightunit.md
|
||||
- docs/models/components/distanceunittemplate.md
|
||||
- docs/models/components/ancillaryendorsement.md
|
||||
- docs/models/components/dangerousgoodscode.md
|
||||
- docs/models/components/lasershipattrs.md
|
||||
- docs/models/components/preferreddeliverytimeframe.md
|
||||
- docs/models/components/returnservicetype.md
|
||||
- docs/models/components/signatureconfirmation.md
|
||||
- docs/models/components/shipmentextra.md
|
||||
- docs/models/components/rmanumber.md
|
||||
- docs/models/components/ponumber.md
|
||||
- docs/models/components/invoicenumber.md
|
||||
- docs/models/components/provider.md
|
||||
- docs/models/components/insurance.md
|
||||
- docs/models/components/dryice.md
|
||||
- docs/models/components/departmentnumber.md
|
||||
- docs/models/components/dangerousgoodsobject.md
|
||||
- docs/models/components/dangerousgoodslithiumbatteries.md
|
||||
- docs/models/components/dangerousgoodsbiologicalmaterial.md
|
||||
- docs/models/components/customerreference.md
|
||||
- docs/models/components/paymentmethod.md
|
||||
- docs/models/components/cod.md
|
||||
- docs/models/components/type.md
|
||||
- docs/models/components/billing.md
|
||||
- docs/models/components/recipienttype.md
|
||||
- docs/models/components/alcohol.md
|
||||
- docs/models/components/labelfiletype.md
|
||||
- docs/models/components/batchcreaterequest.md
|
||||
- docs/models/components/batchshipmentbase.md
|
||||
- docs/models/components/carrieraccountlistwrapper.md
|
||||
- docs/models/components/carrieraccount.md
|
||||
- docs/models/components/upsconnectexistingownaccountparameters.md
|
||||
- docs/models/components/connectexistingownupsaccountrequest.md
|
||||
- docs/models/components/carrieraccountbase.md
|
||||
- docs/models/components/carrieraccountcanadapostcreaterequest.md
|
||||
- docs/models/components/carrieraccountcanadapostcreateparameters.md
|
||||
- docs/models/components/parameters.md
|
||||
- docs/models/components/carrieraccountchronopostcreaterequest.md
|
||||
- docs/models/components/carrieraccountcolissimocreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountcolissimocreaterequest.md
|
||||
- docs/models/components/carrieraccountcorreoscreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountcorreoscreaterequest.md
|
||||
- docs/models/components/carrieraccountdeutschepostcreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountdeutschepostcreaterequest.md
|
||||
- docs/models/components/carrieraccountdhlexpresscreaterequest.md
|
||||
- docs/models/components/carrieraccountdhlexpresscreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountdpddecreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountdpddecreaterequest.md
|
||||
- docs/models/components/carrieraccountdpdukcreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountdpdukcreaterequest.md
|
||||
- docs/models/components/carrieraccounthermesukcreaterequestparameters.md
|
||||
- docs/models/components/carrieraccounthermesukcreaterequest.md
|
||||
- docs/models/components/carrieraccountposteitalianecreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountposteitalianecreaterequest.md
|
||||
- docs/models/components/carrieraccountupscreaterequest.md
|
||||
- docs/models/components/carrieraccountupscreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountuspscreaterequestparameters.md
|
||||
- docs/models/components/carrieraccountuspscreaterequest.md
|
||||
- docs/models/components/carrieraccountregistrationstatus.md
|
||||
- docs/models/components/customsdeclarationlistwrapper.md
|
||||
- docs/models/components/b13afilingoption.md
|
||||
- docs/models/components/contentstype.md
|
||||
- docs/models/components/eelpfc.md
|
||||
- docs/models/components/incoterm.md
|
||||
- docs/models/components/nondeliveryoption.md
|
||||
- docs/models/components/customsdeclarationaddressimporter.md
|
||||
- docs/models/components/customsdeclaration.md
|
||||
- docs/models/components/objectstate.md
|
||||
- docs/models/components/customsinvoicedcharges.md
|
||||
- docs/models/components/customsexporteridentification.md
|
||||
- docs/models/components/customstaxidentificationtype.md
|
||||
- docs/models/components/customstaxidentification.md
|
||||
- docs/models/components/customsdeclarationcreaterequestb13afilingoption.md
|
||||
- docs/models/components/customsdeclarationcreaterequestcontentstype.md
|
||||
- docs/models/components/customsdeclarationcreaterequesteelpfc.md
|
||||
- docs/models/components/customsdeclarationcreaterequestincoterm.md
|
||||
- docs/models/components/customsdeclarationcreaterequestnondeliveryoption.md
|
||||
- docs/models/components/customsdeclarationcreaterequest.md
|
||||
- docs/models/components/customsitembase.md
|
||||
- docs/models/components/addressimporter.md
|
||||
- docs/models/components/customsitemlistwrapper.md
|
||||
- docs/models/components/customsitem.md
|
||||
- docs/models/components/invoice.md
|
||||
- docs/models/components/amountandcurrencycharged.md
|
||||
- docs/models/components/amountandcurrencyinvoiced.md
|
||||
- docs/models/components/invoicestatus.md
|
||||
- docs/models/components/invoicelistwrapper.md
|
||||
- docs/models/components/invoiceitemlistwrapper.md
|
||||
- docs/models/components/invoiceitem.md
|
||||
- docs/models/components/conversionamount.md
|
||||
- docs/models/components/invoiceitemtypes.md
|
||||
- docs/models/components/liveratelist.md
|
||||
- docs/models/components/liverate.md
|
||||
- docs/models/components/addressfrom.md
|
||||
- docs/models/components/addressto.md
|
||||
- docs/models/components/liveratecreaterequestparcel.md
|
||||
- docs/models/components/liveratecreaterequest.md
|
||||
- docs/models/components/parcelobjectstate.md
|
||||
- docs/models/components/parcel.md
|
||||
- docs/models/components/parcelextra.md
|
||||
- docs/models/components/parcelinsuranceprovider.md
|
||||
- docs/models/components/parcelinsurance.md
|
||||
- docs/models/components/lineitem.md
|
||||
- docs/models/components/addresscompletecreaterequest.md
|
||||
- docs/models/components/defaultparceltemplate.md
|
||||
- docs/models/components/userparceltemplate.md
|
||||
- docs/models/components/carrierparceltemplatestruct.md
|
||||
- docs/models/components/distanceunit.md
|
||||
- docs/models/components/distanceunitusertemplate.md
|
||||
- docs/models/components/defaultparceltemplateupdaterequest.md
|
||||
- docs/models/components/manifestlistwrapper.md
|
||||
- docs/models/components/manifeststatus.md
|
||||
- docs/models/components/manifest.md
|
||||
- docs/models/components/manifestcreaterequestaddressfrom.md
|
||||
- docs/models/components/manifestcreaterequest.md
|
||||
- docs/models/components/orderlistwrapper.md
|
||||
- docs/models/components/orderstatus.md
|
||||
- docs/models/components/shopapp.md
|
||||
- docs/models/components/order.md
|
||||
- docs/models/components/ordercreaterequestorderstatus.md
|
||||
- docs/models/components/ordercreaterequest.md
|
||||
- docs/models/components/lineitembase.md
|
||||
- docs/models/components/carrierparceltemplatestructlistwrapper.md
|
||||
- docs/models/components/parcellistwrapper.md
|
||||
- docs/models/components/parcelrequest.md
|
||||
- docs/models/components/pickupstatus.md
|
||||
- docs/models/components/pickup.md
|
||||
- docs/models/components/buildinglocationtype.md
|
||||
- docs/models/components/buildingtype.md
|
||||
- docs/models/components/location.md
|
||||
- docs/models/components/pickupbase.md
|
||||
- docs/models/components/attributes.md
|
||||
- docs/models/components/rate.md
|
||||
- docs/models/components/servicelevel.md
|
||||
- docs/models/components/ratemessage.md
|
||||
- docs/models/components/ratelistwrapper.md
|
||||
- docs/models/components/refundstatus.md
|
||||
- docs/models/components/refund.md
|
||||
- docs/models/components/refundrequestbody.md
|
||||
- docs/models/components/refundlistwrapper.md
|
||||
- docs/models/components/servicegrouptype.md
|
||||
- docs/models/components/servicegroup.md
|
||||
- docs/models/components/servicegroupcreaterequesttype.md
|
||||
- docs/models/components/servicegroupcreaterequest.md
|
||||
- docs/models/components/shipmentlistwrapper.md
|
||||
- docs/models/components/messages.md
|
||||
- docs/models/components/shipmentstatus.md
|
||||
- docs/models/components/shipment.md
|
||||
- docs/models/components/parceltemplate.md
|
||||
- docs/models/components/track.md
|
||||
- docs/models/components/trackingstatusstatus.md
|
||||
- docs/models/components/trackingstatus.md
|
||||
- docs/models/components/trackingstatussubstatus.md
|
||||
- docs/models/components/trackingstatuslocationbase.md
|
||||
- docs/models/components/tracksrequest.md
|
||||
- docs/models/components/transactionlistwrapper.md
|
||||
- docs/models/components/transactionmessages.md
|
||||
- docs/models/components/transactionstatus.md
|
||||
- docs/models/components/transaction.md
|
||||
- docs/models/components/transactioncreaterequest.md
|
||||
- docs/models/components/instanttransactionrequestbodylabelfiletype.md
|
||||
- docs/models/components/instanttransactionrequestbody.md
|
||||
- docs/models/components/userparceltemplatelist.md
|
||||
- docs/models/components/userparceltemplatecreaterequest.md
|
||||
- docs/models/components/userparceltemplatewithcarriertemplatecreaterequest.md
|
||||
- docs/models/components/userparceltemplatewithoutcarriertemplatecreaterequest.md
|
||||
- docs/models/components/userparceltemplateupdaterequest.md
|
||||
- docs/models/components/paginatedshippoaccountresponse.md
|
||||
- docs/models/components/shippoaccount.md
|
||||
- docs/models/components/baseshippoaccountstruct.md
|
||||
- docs/models/components/security.md
|
||||
- docs/models/errors/platformcarrierownaccountcreation400response.md
|
||||
- docs/models/errors/carrieraccountregistrationstatus400response.md
|
||||
- docs/models/errors/tracks400response.md
|
||||
- docs/sdks/shippo/README.md
|
||||
- docs/sdks/addresses/README.md
|
||||
- docs/sdks/batches/README.md
|
||||
- docs/sdks/carrieraccounts/README.md
|
||||
- docs/sdks/customsdeclarations/README.md
|
||||
- docs/sdks/customsitems/README.md
|
||||
- docs/sdks/invoices/README.md
|
||||
- docs/sdks/ratesatcheckout/README.md
|
||||
- docs/sdks/manifests/README.md
|
||||
- docs/sdks/orders/README.md
|
||||
- docs/sdks/carrierparceltemplates/README.md
|
||||
- docs/sdks/parcels/README.md
|
||||
- docs/sdks/pickups/README.md
|
||||
- docs/sdks/rates/README.md
|
||||
- docs/sdks/refunds/README.md
|
||||
- docs/sdks/servicegroups/README.md
|
||||
- docs/sdks/shipments/README.md
|
||||
- docs/sdks/trackingstatus/README.md
|
||||
- docs/sdks/transactions/README.md
|
||||
- docs/sdks/userparceltemplates/README.md
|
||||
- docs/sdks/shippoaccounts/README.md
|
||||
- USAGE.md
|
||||
- .gitattributes
|
||||
- src/shippo/_hooks/sdkhooks.py
|
||||
|
||||
@@ -12,7 +12,7 @@ generation:
|
||||
auth:
|
||||
oAuth2ClientCredentialsEnabled: false
|
||||
python:
|
||||
version: 0.0.1
|
||||
version: 0.1.0
|
||||
additionalDependencies:
|
||||
dependencies: {}
|
||||
extraDependencies:
|
||||
|
||||
223
README.md
223
README.md
@@ -32,12 +32,14 @@ pip install git+<UNSET>.git
|
||||
```python
|
||||
import shippo
|
||||
|
||||
s = shippo.Shippo()
|
||||
s = shippo.Shippo(
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.example(results_per_page=904965)
|
||||
res = s.addresses.list_addresses(page=1, results=25, shippo_api_version='<value>')
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.address_list_wrapper is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -46,9 +48,132 @@ if res.status_code == 200:
|
||||
<!-- Start Available Resources and Operations [operations] -->
|
||||
## Available Resources and Operations
|
||||
|
||||
### [Shippo SDK](docs/sdks/shippo/README.md)
|
||||
### [addresses](docs/sdks/addresses/README.md)
|
||||
|
||||
* [example](docs/sdks/shippo/README.md#example)
|
||||
* [list_addresses](docs/sdks/addresses/README.md#list_addresses) - List all addresses
|
||||
* [create_address](docs/sdks/addresses/README.md#create_address) - Create a new address
|
||||
* [get_address](docs/sdks/addresses/README.md#get_address) - Retrieve an address
|
||||
* [validate_address](docs/sdks/addresses/README.md#validate_address) - Validate an address
|
||||
|
||||
### [batches](docs/sdks/batches/README.md)
|
||||
|
||||
* [create_batch](docs/sdks/batches/README.md#create_batch) - Create a batch
|
||||
* [get_batch](docs/sdks/batches/README.md#get_batch) - Retrieve a batch
|
||||
* [add_shipments_to_batch](docs/sdks/batches/README.md#add_shipments_to_batch) - Add shipments to a batch
|
||||
* [purchase_batch](docs/sdks/batches/README.md#purchase_batch) - Purchase a batch
|
||||
* [remove_shipments_from_batch](docs/sdks/batches/README.md#remove_shipments_from_batch) - Remove shipments from a batch
|
||||
|
||||
### [carrier_accounts](docs/sdks/carrieraccounts/README.md)
|
||||
|
||||
* [list_carrier_accounts](docs/sdks/carrieraccounts/README.md#list_carrier_accounts) - List all carrier accounts
|
||||
* [create_carrier_account](docs/sdks/carrieraccounts/README.md#create_carrier_account) - Create a new carrier account
|
||||
* [get_carrier_account](docs/sdks/carrieraccounts/README.md#get_carrier_account) - Retrieve a carrier account
|
||||
* [update_carrier_account](docs/sdks/carrieraccounts/README.md#update_carrier_account) - Update a carrier account
|
||||
* [register_carrier_account](docs/sdks/carrieraccounts/README.md#register_carrier_account) - Add a Shippo master carrier account
|
||||
* [get_carrier_registration_status](docs/sdks/carrieraccounts/README.md#get_carrier_registration_status) - Get Carrier Registration status
|
||||
|
||||
### [customs_declarations](docs/sdks/customsdeclarations/README.md)
|
||||
|
||||
* [list_customs_declarations](docs/sdks/customsdeclarations/README.md#list_customs_declarations) - List all customs declarations
|
||||
* [create_customs_declaration](docs/sdks/customsdeclarations/README.md#create_customs_declaration) - Create a new customs declaration
|
||||
* [get_customs_declaration](docs/sdks/customsdeclarations/README.md#get_customs_declaration) - Retrieve a customs declaration
|
||||
|
||||
### [customs_items](docs/sdks/customsitems/README.md)
|
||||
|
||||
* [list_customs_items](docs/sdks/customsitems/README.md#list_customs_items) - List all customs items
|
||||
* [create_customs_item](docs/sdks/customsitems/README.md#create_customs_item) - Create a new customs item
|
||||
* [get_customs_item](docs/sdks/customsitems/README.md#get_customs_item) - Retrieve a customs item
|
||||
|
||||
### [invoices](docs/sdks/invoices/README.md)
|
||||
|
||||
* [get_invoice](docs/sdks/invoices/README.md#get_invoice) - Retrieve an invoice
|
||||
* [list_invoices](docs/sdks/invoices/README.md#list_invoices) - List all invoices
|
||||
* [list_invoice_items_template](docs/sdks/invoices/README.md#list_invoice_items_template) - List all invoice items
|
||||
|
||||
### [rates_at_checkout](docs/sdks/ratesatcheckout/README.md)
|
||||
|
||||
* [create_live_rate](docs/sdks/ratesatcheckout/README.md#create_live_rate) - Generate a live rates request
|
||||
* [get_default_parcel_template](docs/sdks/ratesatcheckout/README.md#get_default_parcel_template) - Show current default parcel template
|
||||
* [update_default_parcel_template](docs/sdks/ratesatcheckout/README.md#update_default_parcel_template) - Update default parcel template
|
||||
* [delete_default_parcel_template](docs/sdks/ratesatcheckout/README.md#delete_default_parcel_template) - Clear current default parcel template
|
||||
|
||||
### [manifests](docs/sdks/manifests/README.md)
|
||||
|
||||
* [list_manifests](docs/sdks/manifests/README.md#list_manifests) - List all manifests
|
||||
* [create_manifest](docs/sdks/manifests/README.md#create_manifest) - Create a new manifest
|
||||
* [get_manifest](docs/sdks/manifests/README.md#get_manifest) - Retrieve a manifest
|
||||
|
||||
### [orders](docs/sdks/orders/README.md)
|
||||
|
||||
* [list_orders](docs/sdks/orders/README.md#list_orders) - List all orders
|
||||
* [create_order](docs/sdks/orders/README.md#create_order) - Create a new order
|
||||
* [get_order](docs/sdks/orders/README.md#get_order) - Retrieve an order
|
||||
|
||||
### [carrier_parcel_templates](docs/sdks/carrierparceltemplates/README.md)
|
||||
|
||||
* [list_carrier_parcel_templates](docs/sdks/carrierparceltemplates/README.md#list_carrier_parcel_templates) - List all carrier parcel templates
|
||||
* [get_carrier_parcel_template](docs/sdks/carrierparceltemplates/README.md#get_carrier_parcel_template) - Retrieve a carrier parcel templates
|
||||
|
||||
### [parcels](docs/sdks/parcels/README.md)
|
||||
|
||||
* [list_parcels](docs/sdks/parcels/README.md#list_parcels) - List all parcels
|
||||
* [create_parcel](docs/sdks/parcels/README.md#create_parcel) - Create a new parcel
|
||||
* [get_parcel](docs/sdks/parcels/README.md#get_parcel) - Retrieve an existing parcel
|
||||
|
||||
### [pickups](docs/sdks/pickups/README.md)
|
||||
|
||||
* [create_pickup](docs/sdks/pickups/README.md#create_pickup) - Create a pickup
|
||||
|
||||
### [rates](docs/sdks/rates/README.md)
|
||||
|
||||
* [get_rate](docs/sdks/rates/README.md#get_rate) - Retrieve a rate
|
||||
* [list_shipment_rates](docs/sdks/rates/README.md#list_shipment_rates) - Retrieve shipment rates
|
||||
* [list_shipment_rates_by_currency_code](docs/sdks/rates/README.md#list_shipment_rates_by_currency_code) - Retrieve shipment rates in currency
|
||||
|
||||
### [refunds](docs/sdks/refunds/README.md)
|
||||
|
||||
* [create_refund](docs/sdks/refunds/README.md#create_refund) - Create a refund
|
||||
* [list_refund](docs/sdks/refunds/README.md#list_refund) - List all refunds
|
||||
* [get_refund](docs/sdks/refunds/README.md#get_refund) - Retrieve a refund
|
||||
|
||||
### [service_groups](docs/sdks/servicegroups/README.md)
|
||||
|
||||
* [list_service_groups](docs/sdks/servicegroups/README.md#list_service_groups) - List all service groups
|
||||
* [create_service_group](docs/sdks/servicegroups/README.md#create_service_group) - Create a new service group
|
||||
* [update_service_group](docs/sdks/servicegroups/README.md#update_service_group) - Update an existing service group
|
||||
* [delete_service_group](docs/sdks/servicegroups/README.md#delete_service_group) - Delete a service group
|
||||
|
||||
### [shipments](docs/sdks/shipments/README.md)
|
||||
|
||||
* [list_shipments](docs/sdks/shipments/README.md#list_shipments) - List all shipments
|
||||
* [create_shipment](docs/sdks/shipments/README.md#create_shipment) - Create a new shipment
|
||||
* [get_shipment](docs/sdks/shipments/README.md#get_shipment) - Retrieve a shipment
|
||||
|
||||
### [tracking_status](docs/sdks/trackingstatus/README.md)
|
||||
|
||||
* [create_track](docs/sdks/trackingstatus/README.md#create_track) - Register a tracking webhook
|
||||
* [get_track](docs/sdks/trackingstatus/README.md#get_track) - Get a tracking status
|
||||
|
||||
### [transactions](docs/sdks/transactions/README.md)
|
||||
|
||||
* [list_transactions](docs/sdks/transactions/README.md#list_transactions) - List all shipping labels
|
||||
* [create_transaction](docs/sdks/transactions/README.md#create_transaction) - Create a shipping label
|
||||
* [get_transaction](docs/sdks/transactions/README.md#get_transaction) - Retrieve a shipping label
|
||||
|
||||
### [user_parcel_templates](docs/sdks/userparceltemplates/README.md)
|
||||
|
||||
* [list_user_parcel_templates](docs/sdks/userparceltemplates/README.md#list_user_parcel_templates) - List all user parcel templates
|
||||
* [create_user_parcel_template](docs/sdks/userparceltemplates/README.md#create_user_parcel_template) - Create a new user parcel template
|
||||
* [delete_user_parcel_template](docs/sdks/userparceltemplates/README.md#delete_user_parcel_template) - Delete a user parcel template
|
||||
* [get_user_parcel_template](docs/sdks/userparceltemplates/README.md#get_user_parcel_template) - Retrieves a user parcel template
|
||||
* [update_user_parcel_template](docs/sdks/userparceltemplates/README.md#update_user_parcel_template) - Update an existing user parcel template
|
||||
|
||||
### [shippo_accounts](docs/sdks/shippoaccounts/README.md)
|
||||
|
||||
* [list_shippo_accounts](docs/sdks/shippoaccounts/README.md#list_shippo_accounts) - List all Shippo Accounts
|
||||
* [create_shippo_account](docs/sdks/shippoaccounts/README.md#create_shippo_account) - Create a Shippo Account
|
||||
* [get_shippo_account](docs/sdks/shippoaccounts/README.md#get_shippo_account) - Retrieve a Shippo Account
|
||||
* [update_shippo_account](docs/sdks/shippoaccounts/README.md#update_shippo_account) - Update a Shippo Account
|
||||
<!-- End Available Resources and Operations [operations] -->
|
||||
|
||||
<!-- Start Error Handling [errors] -->
|
||||
@@ -57,26 +182,62 @@ if res.status_code == 200:
|
||||
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an error. If Error objects are specified in your OpenAPI Spec, the SDK will raise the appropriate Error type.
|
||||
|
||||
| Error Object | Status Code | Content Type |
|
||||
| --------------- | --------------- | --------------- |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| errors.PlatformCarrierOwnAccountCreation400Response | 400 | application/json |
|
||||
| errors.SDKError | 4x-5xx | */* |
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import shippo
|
||||
from shippo.models import errors
|
||||
from shippo.models import components, errors
|
||||
|
||||
s = shippo.Shippo()
|
||||
s = shippo.Shippo(
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = None
|
||||
try:
|
||||
res = s.example(results_per_page=904965)
|
||||
res = s.carrier_accounts.create_carrier_account(shippo_api_version='<value>', connect_existing_own_ups_account_request=components.ConnectExistingOwnUPSAccountRequest(
|
||||
account_id='<value>',
|
||||
active=False,
|
||||
parameters=components.UPSConnectExistingOwnAccountParameters(
|
||||
account_number='94567e',
|
||||
billing_address_city='San Francisco',
|
||||
billing_address_country_iso2='US',
|
||||
billing_address_state='CA',
|
||||
billing_address_street1='731 Market St',
|
||||
billing_address_zip='94103',
|
||||
collec_country_iso2='US',
|
||||
collec_zip='94103',
|
||||
company='Shippo',
|
||||
email='hippo@shippo.com',
|
||||
full_name='Shippo Meister',
|
||||
has_invoice=False,
|
||||
phone='1112223333',
|
||||
title='Manager',
|
||||
ups_agreements=False,
|
||||
aia_country_iso2='US',
|
||||
billing_address_street2='STE 200',
|
||||
currency_code='USD',
|
||||
invoice_controlid='1234',
|
||||
invoice_date='20210529',
|
||||
invoice_number='1112234',
|
||||
invoice_value='11.23',
|
||||
),
|
||||
carrier='ups',
|
||||
metadata='UPS Account',
|
||||
test=False,
|
||||
))
|
||||
except errors.PlatformCarrierOwnAccountCreation400Response as e:
|
||||
# handle exception
|
||||
raise(e)
|
||||
except errors.SDKError as e:
|
||||
# handle exception
|
||||
raise(e)
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.carrier_account is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -91,7 +252,7 @@ You can override the default server globally by passing a server index to the `s
|
||||
|
||||
| # | Server | Variables |
|
||||
| - | ------ | --------- |
|
||||
| 0 | `https://example.com` | None |
|
||||
| 0 | `https://api.goshippo.com` | None |
|
||||
|
||||
#### Example
|
||||
|
||||
@@ -100,12 +261,13 @@ import shippo
|
||||
|
||||
s = shippo.Shippo(
|
||||
server_idx=0,
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.example(results_per_page=904965)
|
||||
res = s.addresses.list_addresses(page=1, results=25, shippo_api_version='<value>')
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.address_list_wrapper is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -118,13 +280,14 @@ The default server can also be overridden globally by passing a URL to the `serv
|
||||
import shippo
|
||||
|
||||
s = shippo.Shippo(
|
||||
server_url="https://example.com",
|
||||
server_url="https://api.goshippo.com",
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.example(results_per_page=904965)
|
||||
res = s.addresses.list_addresses(page=1, results=25, shippo_api_version='<value>')
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.address_list_wrapper is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
@@ -146,6 +309,34 @@ s = shippo.Shippo(client: http_client)
|
||||
```
|
||||
<!-- End Custom HTTP Client [http-client] -->
|
||||
|
||||
<!-- Start Authentication [security] -->
|
||||
## Authentication
|
||||
|
||||
### Per-Client Security Schemes
|
||||
|
||||
This SDK supports the following security scheme globally:
|
||||
|
||||
| Name | Type | Scheme |
|
||||
| ---------------- | ---------------- | ---------------- |
|
||||
| `api_key_header` | apiKey | API key |
|
||||
|
||||
To authenticate with the API the `api_key_header` parameter must be set when initializing the SDK client instance. For example:
|
||||
```python
|
||||
import shippo
|
||||
|
||||
s = shippo.Shippo(
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.addresses.list_addresses(page=1, results=25, shippo_api_version='<value>')
|
||||
|
||||
if res.address_list_wrapper is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
<!-- End Authentication [security] -->
|
||||
|
||||
<!-- Placeholder for Future Speakeasy SDK Sections -->
|
||||
|
||||
# Development
|
||||
|
||||
8
USAGE.md
8
USAGE.md
@@ -2,12 +2,14 @@
|
||||
```python
|
||||
import shippo
|
||||
|
||||
s = shippo.Shippo()
|
||||
s = shippo.Shippo(
|
||||
api_key_header="<YOUR_API_KEY_HERE>",
|
||||
)
|
||||
|
||||
|
||||
res = s.example(results_per_page=904965)
|
||||
res = s.addresses.list_addresses(page=1, results=25, shippo_api_version='<value>')
|
||||
|
||||
if res.status_code == 200:
|
||||
if res.address_list_wrapper is not None:
|
||||
# handle response
|
||||
pass
|
||||
```
|
||||
|
||||
32
docs/models/components/address.md
Normal file
32
docs/models/components/address.md
Normal file
@@ -0,0 +1,32 @@
|
||||
# Address
|
||||
|
||||
Address represents the address as retrieved from the database
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `country` | *str* | :heavy_check_mark: | Example: `US` or `DE`. All accepted values can be found on the <br/><a href="http://www.iso.org/" target="blank">Official ISO Website</a>.<br/>Sending a country is always required. | US |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>First and Last Name of the addressee | Shwan Ippotle |
|
||||
| `company` | *Optional[str]* | :heavy_minus_sign: | Company Name | Shippo |
|
||||
| `street1` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no). | 215 Clayton St. |
|
||||
| `street2` | *Optional[str]* | :heavy_minus_sign: | Second street line, 35 character limit. | |
|
||||
| `street3` | *Optional[str]* | :heavy_minus_sign: | Third street line, 35 character limit. <br/>Only accepted for USPS international shipments, UPS domestic and UPS international shipments. | |
|
||||
| `street_no` | *Optional[str]* | :heavy_minus_sign: | Street number of the addressed building. <br/>This field can be included in street1 for all carriers except for DHL Germany. | |
|
||||
| `city` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. <br/>Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state <br/>or a ZIP code (see below), if known, it will yield more accurate results. | San Francisco |
|
||||
| `state` | *Optional[str]* | :heavy_minus_sign: | **required for purchase for some countries**<br><br/>State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some <br/>countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers <br/>only accept two or three character state abbreviations. | CA |
|
||||
| `zip` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more <br/>accurate Rates. | 94117 |
|
||||
| `phone` | *Optional[str]* | :heavy_minus_sign: | Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This <br/>increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. | +1 555 341 9393 |
|
||||
| `email` | *Optional[str]* | :heavy_minus_sign: | E-mail address of the contact person, RFC3696/5321-compliant. | shippotle@shippo.com |
|
||||
| `is_residential` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | Customer ID 123456 |
|
||||
| `latitude` | *Optional[float]* | :heavy_minus_sign: | Latitude of address | |
|
||||
| `longitude` | *Optional[float]* | :heavy_minus_sign: | Longitude of address | |
|
||||
| `is_complete` | *Optional[bool]* | :heavy_minus_sign: | Complete addresses contain all required values.<br><br>Incomplete addresses have failed one or multiple <br/>validations.<br>Incomplete Addresses are eligible for requesting rates but lack at least one required <br/>value for purchasing labels. | true |
|
||||
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of Address creation. | 2014-07-09T02:19:13.174Z |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the given Address object. <br/>This ID is required to create a Shipment object. | d799c2679e644279b59fe661ac8fa488 |
|
||||
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | Username of the user who created the Address object. | shippotle@shippo.com |
|
||||
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of last Address update. Since you cannot update Addresses after they were created, this time <br/>stamp reflects the time when the Address was changed by Shippo's systems for the last time, e.g., during the <br/>approximation of one or more values. | 2014-07-09T02:19:13.174Z |
|
||||
| `validation_results` | [Optional[components.AddressValidationResults]](../../models/components/addressvalidationresults.md) | :heavy_minus_sign: | Object that contains information regarding if an address had been validated or not. Also contains any messages <br/>generated during validation. Children keys are <code>is_valid</code>(boolean) and <code>messages</code>(array). | |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | false |
|
||||
26
docs/models/components/addresscompletecreaterequest.md
Normal file
26
docs/models/components/addresscompletecreaterequest.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# AddressCompleteCreateRequest
|
||||
|
||||
Address represents the address as retrieved from the database
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | *str* | :heavy_check_mark: | **required for purchase**<br><br/>First and Last Name of the addressee | Shwan Ippotle |
|
||||
| `street1` | *str* | :heavy_check_mark: | **required for purchase**<br><br/>First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no). | 215 Clayton St. |
|
||||
| `city` | *str* | :heavy_check_mark: | **required for purchase**<br><br/>Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. <br/>Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state <br/>or a ZIP code (see below), if known, it will yield more accurate results. | San Francisco |
|
||||
| `state` | *str* | :heavy_check_mark: | **required for purchase for some countries**<br><br/>State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some <br/>countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers <br/>only accept two or three character state abbreviations. | CA |
|
||||
| `zip` | *str* | :heavy_check_mark: | **required for purchase**<br><br/>Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more <br/>accurate Rates. | 94117 |
|
||||
| `country` | *str* | :heavy_check_mark: | Example: `US` or `DE`. All accepted values can be found on the <br/><a href="http://www.iso.org/" target="blank">Official ISO Website</a>.<br/>Sending a country is always required. | US |
|
||||
| `company` | *Optional[str]* | :heavy_minus_sign: | Company Name | Shippo |
|
||||
| `street2` | *Optional[str]* | :heavy_minus_sign: | Second street line, 35 character limit. | |
|
||||
| `street3` | *Optional[str]* | :heavy_minus_sign: | Third street line, 35 character limit. <br/>Only accepted for USPS international shipments, UPS domestic and UPS international shipments. | |
|
||||
| `street_no` | *Optional[str]* | :heavy_minus_sign: | Street number of the addressed building. <br/>This field can be included in street1 for all carriers except for DHL Germany. | |
|
||||
| `phone` | *Optional[str]* | :heavy_minus_sign: | Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This <br/>increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. | +1 555 341 9393 |
|
||||
| `email` | *Optional[str]* | :heavy_minus_sign: | E-mail address of the contact person, RFC3696/5321-compliant. | shippotle@shippo.com |
|
||||
| `is_residential` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | Customer ID 123456 |
|
||||
| `latitude` | *Optional[float]* | :heavy_minus_sign: | Latitude of address | |
|
||||
| `longitude` | *Optional[float]* | :heavy_minus_sign: | Longitude of address | |
|
||||
| `validate` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
26
docs/models/components/addresscreaterequest.md
Normal file
26
docs/models/components/addresscreaterequest.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# AddressCreateRequest
|
||||
|
||||
Address represents the address as retrieved from the database
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `country` | *str* | :heavy_check_mark: | Example: `US` or `DE`. All accepted values can be found on the <br/><a href="http://www.iso.org/" target="blank">Official ISO Website</a>.<br/>Sending a country is always required. | US |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>First and Last Name of the addressee | Shwan Ippotle |
|
||||
| `company` | *Optional[str]* | :heavy_minus_sign: | Company Name | Shippo |
|
||||
| `street1` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no). | 215 Clayton St. |
|
||||
| `street2` | *Optional[str]* | :heavy_minus_sign: | Second street line, 35 character limit. | |
|
||||
| `street3` | *Optional[str]* | :heavy_minus_sign: | Third street line, 35 character limit. <br/>Only accepted for USPS international shipments, UPS domestic and UPS international shipments. | |
|
||||
| `street_no` | *Optional[str]* | :heavy_minus_sign: | Street number of the addressed building. <br/>This field can be included in street1 for all carriers except for DHL Germany. | |
|
||||
| `city` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>Name of a city. When creating a Quote Address, sending a city is optional but will yield more accurate Rates. <br/>Please bear in mind that city names may be ambiguous (there are 34 Springfields in the US). Pass in a state <br/>or a ZIP code (see below), if known, it will yield more accurate results. | San Francisco |
|
||||
| `state` | *Optional[str]* | :heavy_minus_sign: | **required for purchase for some countries**<br><br/>State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some <br/>countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers <br/>only accept two or three character state abbreviations. | CA |
|
||||
| `zip` | *Optional[str]* | :heavy_minus_sign: | **required for purchase**<br><br/>Postal code of an Address. When creating a Quote Addresses, sending a ZIP is optional but will yield more <br/>accurate Rates. | 94117 |
|
||||
| `phone` | *Optional[str]* | :heavy_minus_sign: | Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This <br/>increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. | +1 555 341 9393 |
|
||||
| `email` | *Optional[str]* | :heavy_minus_sign: | E-mail address of the contact person, RFC3696/5321-compliant. | shippotle@shippo.com |
|
||||
| `is_residential` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | Customer ID 123456 |
|
||||
| `latitude` | *Optional[float]* | :heavy_minus_sign: | Latitude of address | |
|
||||
| `longitude` | *Optional[float]* | :heavy_minus_sign: | Longitude of address | |
|
||||
| `validate` | *Optional[bool]* | :heavy_minus_sign: | Set to true to validate Address object. | true |
|
||||
21
docs/models/components/addressfrom.md
Normal file
21
docs/models/components/addressfrom.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddressFrom
|
||||
|
||||
The sender address, which includes your name, company name, street address, city, state, zip code,
|
||||
country, phone number, and email address (strings). Special characters should not be included in
|
||||
any address element, especially name, company, and email.
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
###
|
||||
|
||||
```python
|
||||
addressFrom: str = /* values here */
|
||||
```
|
||||
|
||||
### AddressCompleteCreateRequest
|
||||
|
||||
```python
|
||||
addressFrom: components.AddressCompleteCreateRequest = /* values here */
|
||||
```
|
||||
|
||||
22
docs/models/components/addressimporter.md
Normal file
22
docs/models/components/addressimporter.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# AddressImporter
|
||||
|
||||
Object that represents the address of the importer
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | First and Last Name of the addressee | Shwan Ippotle |
|
||||
| `company` | *Optional[str]* | :heavy_minus_sign: | Company Name | Shippo |
|
||||
| `street1` | *Optional[str]* | :heavy_minus_sign: | First street line, 35 character limit. Usually street number and street name (except for DHL Germany, see street_no). | Blumenstraße |
|
||||
| `street2` | *Optional[str]* | :heavy_minus_sign: | Second street line, 35 character limit. | |
|
||||
| `street3` | *Optional[str]* | :heavy_minus_sign: | Third street line, 35 character limit. <br/>Only accepted for USPS international shipments, UPS domestic and UPS international shipments. | |
|
||||
| `street_no` | *Optional[str]* | :heavy_minus_sign: | Street number of the addressed building. <br/>This field can be included in street1 for all carriers except for DHL Germany. | 22 |
|
||||
| `city` | *Optional[str]* | :heavy_minus_sign: | Name of a city | München |
|
||||
| `state` | *Optional[str]* | :heavy_minus_sign: | **required for purchase for some countries**<br><br/>State/Province values are required for shipments from/to the US, AU, and CA. UPS requires province for some <br/>countries (i.e Ireland). To receive more accurate quotes, passing this field is recommended. Most carriers <br/>only accept two or three character state abbreviations. | CA |
|
||||
| `zip` | *Optional[str]* | :heavy_minus_sign: | Postal code of an Address. | 80331 |
|
||||
| `country` | *Optional[str]* | :heavy_minus_sign: | Example: `US` or `DE`. All accepted values can be found on the <br/><a href="http://www.iso.org/" target="blank">Official ISO Website</a>.<br/>Sending a country is always required. | DE |
|
||||
| `phone` | *Optional[str]* | :heavy_minus_sign: | Addresses containing a phone number allow carriers to call the recipient when delivering the Parcel. This <br/>increases the probability of delivery and helps to avoid accessorial charges after a Parcel has been shipped. | 80331 |
|
||||
| `email` | *Optional[str]* | :heavy_minus_sign: | E-mail address of the contact person, RFC3696/5321-compliant. | shippotle@shippo.com |
|
||||
| `is_residential` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the address provided is a residential address or not. | true |
|
||||
12
docs/models/components/addresslistwrapper.md
Normal file
12
docs/models/components/addresslistwrapper.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AddressListWrapper
|
||||
|
||||
Paginated Address Response.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.Address](../../models/components/address.md)] | :heavy_minus_sign: | N/A | |
|
||||
21
docs/models/components/addressto.md
Normal file
21
docs/models/components/addressto.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# AddressTo
|
||||
|
||||
The recipient address, which includes the recipient's name, company name, street address, city, state, zip code,
|
||||
country, phone number, and email address (strings). Special characters should not be included in
|
||||
any address element, especially name, company, and email.
|
||||
|
||||
|
||||
## Supported Types
|
||||
|
||||
###
|
||||
|
||||
```python
|
||||
addressTo: str = /* values here */
|
||||
```
|
||||
|
||||
### AddressCompleteCreateRequest
|
||||
|
||||
```python
|
||||
addressTo: components.AddressCompleteCreateRequest = /* values here */
|
||||
```
|
||||
|
||||
12
docs/models/components/addressvalidationresults.md
Normal file
12
docs/models/components/addressvalidationresults.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# AddressValidationResults
|
||||
|
||||
Object that contains information regarding if an address had been validated or not. Also contains any messages
|
||||
generated during validation. Children keys are <code>is_valid</code>(boolean) and <code>messages</code>(array).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `is_valid` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `messages` | List[[components.AddressValidationResultsMessage](../../models/components/addressvalidationresultsmessage.md)] | :heavy_minus_sign: | N/A | |
|
||||
11
docs/models/components/addressvalidationresultsmessage.md
Normal file
11
docs/models/components/addressvalidationresultsmessage.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AddressValidationResultsMessage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `code` | [Optional[components.Code]](../../models/components/code.md) | :heavy_minus_sign: | N/A | Unknown Street |
|
||||
| `source` | [Optional[components.Source]](../../models/components/source.md) | :heavy_minus_sign: | N/A | Shippo Address Validator |
|
||||
| `text` | *Optional[str]* | :heavy_minus_sign: | N/A | City, State and ZIP Code are valid, but street address is not a match. |
|
||||
| `type` | *Optional[str]* | :heavy_minus_sign: | N/A | address_warning |
|
||||
11
docs/models/components/alcohol.md
Normal file
11
docs/models/components/alcohol.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# Alcohol
|
||||
|
||||
Indicates that a shipment contains Alcohol (Fedex and UPS only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------- |
|
||||
| `contains_alcohol` | *Optional[bool]* | :heavy_minus_sign: | Mandatory for Fedex and UPS. Specifies that the package contains Alcohol. |
|
||||
| `recipient_type` | [Optional[components.RecipientType]](../../models/components/recipienttype.md) | :heavy_minus_sign: | Mandatory for Fedex only. License type of the recipient of the Alcohol Package. |
|
||||
11
docs/models/components/amountandcurrencycharged.md
Normal file
11
docs/models/components/amountandcurrencycharged.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AmountAndCurrencyCharged
|
||||
|
||||
The amount and currency that was charged after possible currency conversion occurred.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `amount` | *Optional[str]* | :heavy_minus_sign: | The money amount | 5.52 |
|
||||
| `currency` | *Optional[str]* | :heavy_minus_sign: | The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. "USD" or "EUR".<br/><a href="http://www.xe.com/iso4217.php" target="blank">ISO 4217 Standard</a>. | USD |
|
||||
11
docs/models/components/amountandcurrencyinvoiced.md
Normal file
11
docs/models/components/amountandcurrencyinvoiced.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AmountAndCurrencyInvoiced
|
||||
|
||||
The amount and currency.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `amount` | *Optional[str]* | :heavy_minus_sign: | The money amount | 5.52 |
|
||||
| `currency` | *Optional[str]* | :heavy_minus_sign: | The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. "USD" or "EUR".<br/><a href="http://www.xe.com/iso4217.php" target="blank">ISO 4217 Standard</a>. | USD |
|
||||
11
docs/models/components/ancillaryendorsement.md
Normal file
11
docs/models/components/ancillaryendorsement.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# AncillaryEndorsement
|
||||
|
||||
Specify an ancillary service endorsement to provide the USPS with instructions on how to handle undeliverable-as-addressed pieces (DHL eCommerce only).
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------------------------ | ------------------------------ |
|
||||
| `FORWARDING_SERVICE_REQUESTED` | FORWARDING_SERVICE_REQUESTED |
|
||||
| `RETURN_SERVICE_REQUESTED` | RETURN_SERVICE_REQUESTED |
|
||||
10
docs/models/components/attributes.md
Normal file
10
docs/models/components/attributes.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# Attributes
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------- | ----------- |
|
||||
| `BESTVALUE` | BESTVALUE |
|
||||
| `CHEAPEST` | CHEAPEST |
|
||||
| `FASTEST` | FASTEST |
|
||||
13
docs/models/components/b13afilingoption.md
Normal file
13
docs/models/components/b13afilingoption.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# B13aFilingOption
|
||||
|
||||
B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS).
|
||||
<a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a>
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `FILED_ELECTRONICALLY` | FILED_ELECTRONICALLY |
|
||||
| `SUMMARY_REPORTING` | SUMMARY_REPORTING |
|
||||
| `NOT_REQUIRED` | NOT_REQUIRED |
|
||||
11
docs/models/components/baseshippoaccountstruct.md
Normal file
11
docs/models/components/baseshippoaccountstruct.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# BaseShippoAccountStruct
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------ | ------------------ | ------------------ | ------------------ | ------------------ |
|
||||
| `email` | *str* | :heavy_check_mark: | N/A | hippo@shippo.com |
|
||||
| `first_name` | *str* | :heavy_check_mark: | N/A | Shippo |
|
||||
| `last_name` | *str* | :heavy_check_mark: | N/A | Meister |
|
||||
| `company_name` | *str* | :heavy_check_mark: | N/A | Acme |
|
||||
20
docs/models/components/batch.md
Normal file
20
docs/models/components/batch.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# Batch
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default_carrier_account` | *str* | :heavy_check_mark: | ID of the Carrier Account object to use as the default for all shipments in this Batch. <br/>The carrier account can be changed on a per-shipment basis by changing the carrier_account in the <br/>corresponding BatchShipment object. | 078870331023437cb917f5187429b093 |
|
||||
| `default_servicelevel_token` | *str* | :heavy_check_mark: | Token of the service level to use as the default for all shipments in this Batch. <br/>The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the <br/>corresponding BatchShipment object. <a href="#tag/Service-Levels">Servicelevel tokens can be found here.</a> | usps_priority |
|
||||
| `batch_shipments` | [components.BatchShipmentListWrapper](../../models/components/batchshipmentlistwrapper.md) | :heavy_check_mark: | N/A | |
|
||||
| `label_url` | List[*str*] | :heavy_check_mark: | An array of URLs each pointing to a merged file of 100 labels each | |
|
||||
| `object_created` | *str* | :heavy_check_mark: | Date and time of Batch creation | 2016-01-04T00:15:44.394Z |
|
||||
| `object_id` | *str* | :heavy_check_mark: | Unique identifier of the given Batch object | 5ef63c54f5bf45d3b1f8fb37dcb1c5f4 |
|
||||
| `object_owner` | *str* | :heavy_check_mark: | Username of the user who created the Address object. | shippo@shippo.com |
|
||||
| `object_results` | [components.ObjectResults](../../models/components/objectresults.md) | :heavy_check_mark: | An object containing the following counts:<br>`creation_succeeded`<br>`creation_failed`<br>`purchase_succeeded`<br>`purchase_failed` | |
|
||||
| `object_updated` | *str* | :heavy_check_mark: | Date and time of last update to the Batch | 2016-01-04T00:48:13.841Z |
|
||||
| `status` | [components.BatchStatus](../../models/components/batchstatus.md) | :heavy_check_mark: | Batches that are `VALIDATING` are being created and validated<br><br/>`VALID` batches can be purchased<br><br/>`INVALID` batches cannot be purchased, `INVALID` BatchShipments must be removed<br><br/>Batches that are in the `PURCHASING` state are being purchased<br><br/>`PURCHASED` batches are finished purchasing. | VALID |
|
||||
| `label_filetype` | [Optional[components.LabelFileType]](../../models/components/labelfiletype.md) | :heavy_minus_sign: | Print format of the <a href="https://docs.goshippo.com/docs/shipments/shippinglabelsizes/">label</a>. If empty, will use the default format set from <br/><a href="https://apps.goshippo.com/settings/labels">the Shippo dashboard.</a> | PDF_4x6 |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | BATCH #1 |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
12
docs/models/components/batchcreaterequest.md
Normal file
12
docs/models/components/batchcreaterequest.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# BatchCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `default_carrier_account` | *str* | :heavy_check_mark: | ID of the Carrier Account object to use as the default for all shipments in this Batch. <br/>The carrier account can be changed on a per-shipment basis by changing the carrier_account in the <br/>corresponding BatchShipment object. | 078870331023437cb917f5187429b093 |
|
||||
| `default_servicelevel_token` | *str* | :heavy_check_mark: | Token of the service level to use as the default for all shipments in this Batch. <br/>The servicelevel can be changed on a per-shipment basis by changing the servicelevel_token in the <br/>corresponding BatchShipment object. <a href="#tag/Service-Levels">Servicelevel tokens can be found here.</a> | usps_priority |
|
||||
| `batch_shipments` | List[[components.BatchShipmentBase](../../models/components/batchshipmentbase.md)] | :heavy_check_mark: | Array of BatchShipment objects. The response keeps the same order as in the request array. | |
|
||||
| `label_filetype` | [Optional[components.LabelFileType]](../../models/components/labelfiletype.md) | :heavy_minus_sign: | Print format of the <a href="https://docs.goshippo.com/docs/shipments/shippinglabelsizes/">label</a>. If empty, will use the default format set from <br/><a href="https://apps.goshippo.com/settings/labels">the Shippo dashboard.</a> | PDF_4x6 |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want to attach to the object. | BATCH #1 |
|
||||
15
docs/models/components/batchshipment.md
Normal file
15
docs/models/components/batchshipment.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# BatchShipment
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | |
|
||||
| `object_id` | *str* | :heavy_check_mark: | Object ID of this batch shipment. Can be used in the remove_shipments endpoint. | e11c95a6788d4ddcaa22f03175838740 |
|
||||
| `status` | [components.Status](../../models/components/status.md) | :heavy_check_mark: | `INVALID` batch shipments cannot be purchased and will have to be removed, fixed, and added to the batch again.<br><br/>`VALID` batch shipments can be purchased. <br><br/>Batch shipments with the status `TRANSACTION_FAILED` were not able to be purchased and the error will be displayed on the message field<br> <br/>`INCOMPLETE` batch shipments have an issue with the Address and will need to be removed, fixed, and added to the batch again. | INVALID |
|
||||
| `carrier_account` | *Optional[str]* | :heavy_minus_sign: | Object ID of the carrier account to be used for this shipment (will override batch default) | a4391cd4ab974f478f55dc08b5c8e3b3 |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | SHIPMENT #1 |
|
||||
| `servicelevel_token` | *Optional[str]* | :heavy_minus_sign: | A token that sets the shipping method for the batch, overriding the batch default. <br/>Servicelevel tokens can be found <a href="#tag/Service-Levels">in this list</a> <br/>or <a href="#operation/ListCarrierAccounts">at this endpoint</a>. | fedex_ground |
|
||||
| `messages` | List[[components.ErrorMessage](../../models/components/errormessage.md)] | :heavy_minus_sign: | List of Shipment and Transaction error messages. | |
|
||||
| `transaction` | *Optional[str]* | :heavy_minus_sign: | Object ID of the transaction object created for this batch shipment. | 4c33736a67e2450da88b38c42deef6b7 |
|
||||
11
docs/models/components/batchshipmentbase.md
Normal file
11
docs/models/components/batchshipmentbase.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# BatchShipmentBase
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | |
|
||||
| `carrier_account` | *Optional[str]* | :heavy_minus_sign: | Object ID of the carrier account to be used for this shipment (will override batch default) | a4391cd4ab974f478f55dc08b5c8e3b3 |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you want <br/>to attach to the object. | SHIPMENT #1 |
|
||||
| `servicelevel_token` | *Optional[str]* | :heavy_minus_sign: | A token that sets the shipping method for the batch, overriding the batch default. <br/>Servicelevel tokens can be found <a href="#tag/Service-Levels">in this list</a> <br/>or <a href="#operation/ListCarrierAccounts">at this endpoint</a>. | fedex_ground |
|
||||
13
docs/models/components/batchshipmentlistwrapper.md
Normal file
13
docs/models/components/batchshipmentlistwrapper.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# BatchShipmentListWrapper
|
||||
|
||||
Array of <a href="#section/Batch-Shipment">BatchShipment</a> objects.
|
||||
The response keeps the same order as in the request array.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.BatchShipment](../../models/components/batchshipment.md)] | :heavy_minus_sign: | N/A | |
|
||||
18
docs/models/components/batchstatus.md
Normal file
18
docs/models/components/batchstatus.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# BatchStatus
|
||||
|
||||
Batches that are `VALIDATING` are being created and validated<br>
|
||||
`VALID` batches can be purchased<br>
|
||||
`INVALID` batches cannot be purchased, `INVALID` BatchShipments must be removed<br>
|
||||
Batches that are in the `PURCHASING` state are being purchased<br>
|
||||
`PURCHASED` batches are finished purchasing.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `VALIDATING` | VALIDATING |
|
||||
| `VALID` | VALID |
|
||||
| `INVALID` | INVALID |
|
||||
| `PURCHASING` | PURCHASING |
|
||||
| `PURCHASED` | PURCHASED |
|
||||
14
docs/models/components/billing.md
Normal file
14
docs/models/components/billing.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# Billing
|
||||
|
||||
Specify billing details (UPS, FedEx, and DHL Germany only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
|
||||
| `account` | *Optional[str]* | :heavy_minus_sign: | Account number to be billed. (For DHL Germany, leave this field blank.) |
|
||||
| `country` | *Optional[str]* | :heavy_minus_sign: | Country iso2 code of account number to be billed (required for UPS third party billing only). |
|
||||
| `participation_code` | *Optional[str]* | :heavy_minus_sign: | 2 digit code used to override your default participation code associated with your DHL Germany account. |
|
||||
| `type` | [Optional[components.Type]](../../models/components/type.md) | :heavy_minus_sign: | Party to be billed. (Leave blank for DHL Germany.) |
|
||||
| `zip` | *Optional[str]* | :heavy_minus_sign: | ZIP code of account number to be billed (required for UPS if there is a zip on the billing account). |
|
||||
22
docs/models/components/buildinglocationtype.md
Normal file
22
docs/models/components/buildinglocationtype.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# BuildingLocationType
|
||||
|
||||
Where your parcels will be available for pickup. "Security Deck" and "Shipping Dock" are only
|
||||
supported for DHL Express.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `BACK_DOOR` | Back Door |
|
||||
| `RING_BELL` | Ring Bell |
|
||||
| `SECURITY_DECK` | Security Deck |
|
||||
| `SHIPPING_DOCK` | Shipping Dock |
|
||||
| `FRONT_DOOR` | Front Door |
|
||||
| `KNOCK_ON_DOOR` | Knock on Door |
|
||||
| `IN_AT_MAILBOX` | In/At Mailbox |
|
||||
| `MAIL_ROOM` | Mail Room |
|
||||
| `OFFICE` | Office |
|
||||
| `OTHER` | Other |
|
||||
| `RECEPTION` | Reception |
|
||||
| `SIDE_DOOR` | Side Door |
|
||||
15
docs/models/components/buildingtype.md
Normal file
15
docs/models/components/buildingtype.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# BuildingType
|
||||
|
||||
The type of building where the pickup is located.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------ | ------------ |
|
||||
| `APARTMENT` | apartment |
|
||||
| `BUILDING` | building |
|
||||
| `DEPARTMENT` | department |
|
||||
| `FLOOR` | floor |
|
||||
| `ROOM` | room |
|
||||
| `SUITE` | suite |
|
||||
16
docs/models/components/carrieraccount.md
Normal file
16
docs/models/components/carrieraccount.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# CarrierAccount
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `account_id` | *str* | :heavy_check_mark: | Unique identifier of the account. Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> <br/>page for the `account_id` per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | **** |
|
||||
| `carrier` | *str* | :heavy_check_mark: | Name of the carrier (as a token). <br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for all supported carriers. | UPS |
|
||||
| `active` | *Optional[bool]* | :heavy_minus_sign: | Determines whether the account is active. When creating a shipment, if no `carrier_accounts` are explicitly <br/>passed Shippo will query all carrier accounts that have this field set. By default, this is set to True. | |
|
||||
| `parameters` | [Optional[components.UPSConnectExistingOwnAccountParameters]](../../models/components/upsconnectexistingownaccountparameters.md) | :heavy_minus_sign: | An array of additional parameters for the account, such as e.g. password or token.<br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for the parameters per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | |
|
||||
| `is_shippo_account` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the carrier account object. | 6aa34d5f6865448fbb1ee93636e98999 |
|
||||
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | Username of the user who created the carrier account object. | bob+22@gmail.com |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | false |
|
||||
11
docs/models/components/carrieraccountbase.md
Normal file
11
docs/models/components/carrieraccountbase.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CarrierAccountBase
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `account_id` | *str* | :heavy_check_mark: | Unique identifier of the account. Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> <br/>page for the `account_id` per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | **** |
|
||||
| `carrier` | *str* | :heavy_check_mark: | Name of the carrier (as a token). <br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for all supported carriers. | UPS |
|
||||
| `active` | *Optional[bool]* | :heavy_minus_sign: | Determines whether the account is active. When creating a shipment, if no `carrier_accounts` are explicitly <br/>passed Shippo will query all carrier accounts that have this field set. By default, this is set to True. | |
|
||||
| `parameters` | [Optional[components.UPSConnectExistingOwnAccountParameters]](../../models/components/upsconnectexistingownaccountparameters.md) | :heavy_minus_sign: | An array of additional parameters for the account, such as e.g. password or token.<br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for the parameters per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | |
|
||||
@@ -0,0 +1,12 @@
|
||||
# CarrierAccountCanadaPostCreateParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
|
||||
| `canada_post_terms` | *bool* | :heavy_check_mark: | Whether or not the user agrees to Canada Post's terms. If passed in as false, request will fail with error 400 | |
|
||||
| `company` | *str* | :heavy_check_mark: | N/A | Shippo |
|
||||
| `email` | *str* | :heavy_check_mark: | N/A | hippo@shippo.com |
|
||||
| `full_name` | *str* | :heavy_check_mark: | N/A | Shippo Meister |
|
||||
| `phone` | *str* | :heavy_check_mark: | Needs to be a valid phone number and cannot be null | 1112223333 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountCanadaPostCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | canada_post |
|
||||
| `parameters` | [components.CarrierAccountCanadaPostCreateParameters](../../models/components/carrieraccountcanadapostcreateparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountChronopostCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | chronopost |
|
||||
| `parameters` | [components.Parameters](../../models/components/parameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountColissimoCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | colissimo |
|
||||
| `parameters` | [components.CarrierAccountColissimoCreateRequestParameters](../../models/components/carrieraccountcolissimocreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountColissimoCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountCorreosCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | correos |
|
||||
| `parameters` | [components.CarrierAccountCorreosCreateRequestParameters](../../models/components/carrieraccountcorreoscreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountCorreosCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountDeutschePostCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | deustche_post |
|
||||
| `parameters` | [components.CarrierAccountDeutschePostCreateRequestParameters](../../models/components/carrieraccountdeutschepostcreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountDeutschePostCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountDHLExpressCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | dhl_express |
|
||||
| `parameters` | [components.CarrierAccountDHLExpressCreateRequestParameters](../../models/components/carrieraccountdhlexpresscreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,8 @@
|
||||
# CarrierAccountDHLExpressCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `user_accepted_terms_and_conditions` | *bool* | :heavy_check_mark: | Whether or not the user agrees to the DHL Express Terms and Conditions. If passed in as false, request will fail with error 400 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountDpdDeCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | dpd_de |
|
||||
| `parameters` | [components.CarrierAccountDpdDeCreateRequestParameters](../../models/components/carrieraccountdpddecreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountDpdDeCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountDPDUKCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | dpd_uk |
|
||||
| `parameters` | [components.CarrierAccountDPDUKCreateRequestParameters](../../models/components/carrieraccountdpdukcreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountDPDUKCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountHermesUKCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | hermes_uk |
|
||||
| `parameters` | [components.CarrierAccountHermesUKCreateRequestParameters](../../models/components/carrieraccounthermesukcreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountHermesUKCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
10
docs/models/components/carrieraccountlistwrapper.md
Normal file
10
docs/models/components/carrieraccountlistwrapper.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# CarrierAccountListWrapper
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.CarrierAccount](../../models/components/carrieraccount.md)] | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountPosteItalianeCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | poste_italiane |
|
||||
| `parameters` | [components.CarrierAccountPosteItalianeCreateRequestParameters](../../models/components/carrieraccountposteitalianecreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountPosteItalianeCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
12
docs/models/components/carrieraccountregistrationstatus.md
Normal file
12
docs/models/components/carrieraccountregistrationstatus.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# CarrierAccountRegistrationStatus
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- |
|
||||
| `carrier_account` | *Optional[str]* | :heavy_minus_sign: | N/A | 99dc410d295b4a168993cc38809cb123 |
|
||||
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | |
|
||||
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | N/A | tom@gmail.com |
|
||||
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | N/A | |
|
||||
| `status` | *Optional[str]* | :heavy_minus_sign: | N/A | PENDING_TERMS |
|
||||
9
docs/models/components/carrieraccountupscreaterequest.md
Normal file
9
docs/models/components/carrieraccountupscreaterequest.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountUPSCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | ups |
|
||||
| `parameters` | [Optional[components.CarrierAccountUPSCreateRequestParameters]](../../models/components/carrieraccountupscreaterequestparameters.md) | :heavy_minus_sign: | N/A | |
|
||||
@@ -0,0 +1,25 @@
|
||||
# CarrierAccountUPSCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
|
||||
| `billing_address_city` | *str* | :heavy_check_mark: | N/A | San Francisco |
|
||||
| `billing_address_country_iso2` | *str* | :heavy_check_mark: | N/A | US |
|
||||
| `billing_address_state` | *str* | :heavy_check_mark: | N/A | CA |
|
||||
| `billing_address_street1` | *str* | :heavy_check_mark: | N/A | 731 Market St |
|
||||
| `billing_address_zip` | *str* | :heavy_check_mark: | N/A | 94103 |
|
||||
| `pickup_address_city` | *str* | :heavy_check_mark: | User's pickup address city. | San Francisco |
|
||||
| `pickup_address_country_iso2` | *str* | :heavy_check_mark: | User's pickup street 1. | US |
|
||||
| `pickup_address_state` | *str* | :heavy_check_mark: | User's pickup address state. | CA |
|
||||
| `pickup_address_street1` | *str* | :heavy_check_mark: | User's pickup address street 1. | 731 Market St |
|
||||
| `pickup_address_zip` | *str* | :heavy_check_mark: | User's pickup address zip code. | 94103 |
|
||||
| `ups_agreements` | *bool* | :heavy_check_mark: | Whether the user agrees to the UPS terms and conditions or not. Error 400 will be returned if passed in as false | |
|
||||
| `billing_address_street2` | *Optional[str]* | :heavy_minus_sign: | Empty string acceptable for billing_address_street2 | STE 200 |
|
||||
| `company` | *Optional[str]* | :heavy_minus_sign: | Company name. Full name is acceptable in this field if the user has no company name | Shippo |
|
||||
| `email` | *Optional[str]* | :heavy_minus_sign: | N/A | hippo@shippo.com |
|
||||
| `full_name` | *Optional[str]* | :heavy_minus_sign: | N/A | Shippo Meister |
|
||||
| `phone` | *Optional[str]* | :heavy_minus_sign: | Needs to be a valid phone number and cannot be null | 1112223333 |
|
||||
| `pickup_address_same_as_billing_address` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
| `pickup_address_street2` | *Optional[str]* | :heavy_minus_sign: | User's pickup street 2. | STE 200 |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CarrierAccountUSPSCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier` | *str* | :heavy_check_mark: | N/A | usps |
|
||||
| `parameters` | [components.CarrierAccountUSPSCreateRequestParameters](../../models/components/carrieraccountuspscreaterequestparameters.md) | :heavy_check_mark: | N/A | |
|
||||
@@ -0,0 +1,7 @@
|
||||
# CarrierAccountUSPSCreateRequestParameters
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
15
docs/models/components/carrierparceltemplatestruct.md
Normal file
15
docs/models/components/carrierparceltemplatestruct.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# CarrierParcelTemplateStruct
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `carrier` | *Optional[str]* | :heavy_minus_sign: | The name of the carrier that provides this parcel template | FedEx |
|
||||
| `distance_unit` | [Optional[components.DistanceUnit]](../../models/components/distanceunit.md) | :heavy_minus_sign: | The measure unit used for length, width and height. | in |
|
||||
| `height` | *Optional[str]* | :heavy_minus_sign: | The height of the package, in units specified by the distance_unit attribute | 1.5 |
|
||||
| `is_variable_dimensions` | *Optional[str]* | :heavy_minus_sign: | True if the carrier parcel template allows custom dimensions, such as USPS Softpack. | false |
|
||||
| `length` | *Optional[str]* | :heavy_minus_sign: | The length of the package, in units specified by the distance_unit attribute | 12.375 |
|
||||
| `name` | *Optional[str]* | :heavy_minus_sign: | The name of the carrier parcel template | FedEx® Small Box (S1) |
|
||||
| `token` | *Optional[str]* | :heavy_minus_sign: | The unique string representation of the carrier parcel template | FedEx_Box_Small_1 |
|
||||
| `width` | *Optional[str]* | :heavy_minus_sign: | The width of the package, in units specified by the distance_unit attribute | 10.875 |
|
||||
@@ -0,0 +1,10 @@
|
||||
# CarrierParcelTemplateStructListWrapper
|
||||
|
||||
CarrierParcelTemplateStruct List Response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
|
||||
| `results` | List[[components.CarrierParcelTemplateStruct](../../models/components/carrierparceltemplatestruct.md)] | :heavy_minus_sign: | N/A |
|
||||
12
docs/models/components/cod.md
Normal file
12
docs/models/components/cod.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# Cod
|
||||
|
||||
Specify collection on delivery details (UPS only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `amount` | *Optional[str]* | :heavy_minus_sign: | Amount to be collected. | 5.5 |
|
||||
| `currency` | *Optional[str]* | :heavy_minus_sign: | Currency for the amount to be collected. Currently only USD is supported for UPS. | USD |
|
||||
| `payment_method` | [Optional[components.PaymentMethod]](../../models/components/paymentmethod.md) | :heavy_minus_sign: | Secured funds include money orders, certified cheques and others (see <br/><a href="https://www.ups.com/content/us/en/shipping/time/service/value_added/cod.html">UPS</a> for details). <br/>If no payment_method inputted the value defaults to "ANY".) | CASH |
|
||||
67
docs/models/components/code.md
Normal file
67
docs/models/components/code.md
Normal file
@@ -0,0 +1,67 @@
|
||||
# Code
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------------------- | ---------------------------------- |
|
||||
| `VERIFICATION_ERROR` | verification_error |
|
||||
| `UNKNOWN_STREET_LOWER` | unknown_street |
|
||||
| `COMPONENT_MISMATCH_ERROR` | component_mismatch_error |
|
||||
| `MULTIPLE_MATCH` | multiple_match |
|
||||
| `SUB_PREMISE_NUMBER_INVALID` | sub_premise_number_invalid |
|
||||
| `SUB_PREMISE_NUMBER_MISSING` | sub_premise_number_missing |
|
||||
| `PREMISE_NUMBER_INVALID` | premise_number_invalid |
|
||||
| `PREMISE_NUMBER_MISSING` | premise_number_missing |
|
||||
| `BOX_NUMBER_INVALID` | box_number_invalid |
|
||||
| `BOX_NUMBER_MISSING` | box_number_missing |
|
||||
| `PMB_NUMBER_MISSING` | pmb_number_missing |
|
||||
| `POSTAL_CODE_CHANGE` | postal_code_change |
|
||||
| `ADMINISTRATIVE_AREA_CHANGE` | administrative_area_change |
|
||||
| `LOCALITY_CHANGE` | locality_change |
|
||||
| `DEPENDENT_LOCALITY_CHANGE` | dependent_locality_change |
|
||||
| `STREET_NAME_CHANGE` | street_name_change |
|
||||
| `STREET_TYPE_CHANGE` | street_type_change |
|
||||
| `STREET_DIRECTIONAL_CHANGE` | street_directional_change |
|
||||
| `SUB_PREMISE_TYPE_CHANGE` | sub_premise_type_change |
|
||||
| `SUB_PREMISE_NUMBER_CHANGE` | sub_premise_number_change |
|
||||
| `DOUBLE_DEPENDENT_LOCALITY_CHANGE` | double_dependent_locality_change |
|
||||
| `SUBADMINISTRATIVE_AREA_CHANGE` | subadministrative_area_change |
|
||||
| `SUBNATIONAL_AREA_CHANGE` | subnational_area_change |
|
||||
| `PO_BOX_CHANGE` | po_box_change |
|
||||
| `PREMISE_TYPE_CHANGE` | premise_type_change |
|
||||
| `HOUSE_NUMBER_CHANGE` | house_number_change |
|
||||
| `ORGANIZATION_CHANGE` | organization_change |
|
||||
| `EXTRANEOUS_INFORMATION` | extraneous_information |
|
||||
| `USPS_DOOR_INACCESSIBLE` | usps_door_inaccessible |
|
||||
| `ADMINISTRATIVE_AREA_PARTIAL` | administrative_area_partial |
|
||||
| `CITY_PARTIAL` | city_partial |
|
||||
| `STREET_PARTIAL` | street_partial |
|
||||
| `BUILDING_PARTIAL` | building_partial |
|
||||
| `SUBPREMISE_PARTIAL` | subpremise_partial |
|
||||
| `ADMINISTRATIVE_AREA_FULL` | administrative_area_full |
|
||||
| `CITY_FULL` | city_full |
|
||||
| `THOROUGHFARE_FULL` | thoroughfare_full |
|
||||
| `PREMISES_FULL` | premises_full |
|
||||
| `SUBPREMISE_FULL` | subpremise_full |
|
||||
| `GEOCODED_STREET` | geocoded_street |
|
||||
| `GEOCODED_NEIGHBORHOOD` | geocoded_neighborhood |
|
||||
| `GEOCODED_COMMUNITY` | geocoded_community |
|
||||
| `GEOCODED_STATE` | geocoded_state |
|
||||
| `GEOCODED_ROOFTOP` | geocoded_rooftop |
|
||||
| `GEOCODED_INTERPOLATED_ROOFTOP` | geocoded_interpolated_rooftop |
|
||||
| `INVALID_POSTAL_CODE` | invalid_postal_code |
|
||||
| `POSTAL_CODE_NOT_FOUND` | postal_code_not_found |
|
||||
| `EMPTY_REQUEST` | empty_request |
|
||||
| `SERVICE_ERROR` | service_error |
|
||||
| `STREET_DETAIL_MISSING` | street_detail_missing |
|
||||
| `INVALID_CITY_STATE_ZIP` | Invalid City/State/Zip |
|
||||
| `DEFAULT_MATCH` | Default Match |
|
||||
| `UNKNOWN_STREET_MIXED` | Unknown Street |
|
||||
| `ADDRESS_NOT_FOUND` | Address Not Found |
|
||||
| `NON_DELIVERABLE_ZIP4` | Non-Deliverable ZIP4 |
|
||||
| `MULTIPLE_RESPONSES` | Multiple Responses |
|
||||
| `INVALID_DUAL_ADDRESS` | Invalid Dual Address |
|
||||
| `INVALID_STATE` | Invalid State |
|
||||
| `INVALID_CITY` | Invalid City |
|
||||
| `AMBIGUOUS_ADDRESS` | Ambiguous Address |
|
||||
@@ -0,0 +1,13 @@
|
||||
# ConnectExistingOwnUPSAccountRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `account_id` | *str* | :heavy_check_mark: | This field is required as input to the API, but is not used for UPS. Use the empty string. | |
|
||||
| `active` | *bool* | :heavy_check_mark: | N/A | |
|
||||
| `parameters` | [components.UPSConnectExistingOwnAccountParameters](../../models/components/upsconnectexistingownaccountparameters.md) | :heavy_check_mark: | An array of additional parameters for the account, such as e.g. password or token.<br/>Please check the <a href="https://docs.goshippo.com/docs/carriers/carrieraccounts/">carrier accounts tutorial</a> page for the parameters per carrier.<br> <br/>To protect account information, this field will be masked in any API response. | |
|
||||
| `carrier` | *Optional[str]* | :heavy_minus_sign: | N/A | ups |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | UPS Account |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | N/A | false |
|
||||
16
docs/models/components/contentstype.md
Normal file
16
docs/models/components/contentstype.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# ContentsType
|
||||
|
||||
Type of goods of the shipment.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------- | ----------------------- |
|
||||
| `DOCUMENTS` | DOCUMENTS |
|
||||
| `GIFT` | GIFT |
|
||||
| `SAMPLE` | SAMPLE |
|
||||
| `MERCHANDISE` | MERCHANDISE |
|
||||
| `HUMANITARIAN_DONATION` | HUMANITARIAN_DONATION |
|
||||
| `RETURN_MERCHANDISE` | RETURN_MERCHANDISE |
|
||||
| `OTHER` | OTHER |
|
||||
13
docs/models/components/conversionamount.md
Normal file
13
docs/models/components/conversionamount.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# ConversionAmount
|
||||
|
||||
Invoice Item's amount after currency conversion took place.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `rate` | *Optional[str]* | :heavy_minus_sign: | Currency conversion rate, relative to USD, that was used to calculate the converted amount. | 0.89 |
|
||||
| `time` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time the currency conversion took place. | |
|
||||
| `amount` | *Optional[str]* | :heavy_minus_sign: | The money amount after currency conversion. | 4.91 |
|
||||
| `currency` | *Optional[str]* | :heavy_minus_sign: | The currency that 'amount' is in. The official ISO 4217 currency codes are used, e.g. "USD" or "EUR".<br/><a href="http://www.xe.com/iso4217.php" target="blank">ISO 4217 Standard</a>. | USD |
|
||||
11
docs/models/components/customerreference.md
Normal file
11
docs/models/components/customerreference.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CustomerReference
|
||||
|
||||
Specify the reference field on the label (FedEx only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `prefix` | *Optional[str]* | :heavy_minus_sign: | Custom prefix for customer reference field (ZPL labels only). Up to 11 characters, including trailing <br/>spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include<br/>this property. |
|
||||
| `value` | *Optional[str]* | :heavy_minus_sign: | Optional text to be printed on the shipping label for customer reference. Up to 40 characters. If <br/>this is provided, reference_1 will be ignored. |
|
||||
37
docs/models/components/customsdeclaration.md
Normal file
37
docs/models/components/customsdeclaration.md
Normal file
@@ -0,0 +1,37 @@
|
||||
# CustomsDeclaration
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `certify` | *bool* | :heavy_check_mark: | Expresses that the certify_signer has provided all information of this customs declaration truthfully. | true |
|
||||
| `certify_signer` | *str* | :heavy_check_mark: | Name of the person who created the customs declaration and is responsible for the validity of all <br/>information provided. | Shawn Ippotle |
|
||||
| `contents_type` | [components.ContentsType](../../models/components/contentstype.md) | :heavy_check_mark: | Type of goods of the shipment. | MERCHANDISE |
|
||||
| `non_delivery_option` | [components.NonDeliveryOption](../../models/components/nondeliveryoption.md) | :heavy_check_mark: | Indicates how the carrier should proceed in case the shipment can't be delivered. | |
|
||||
| `items` | List[*str*] | :heavy_check_mark: | Distinct Parcel content items as Customs Items object_ids. | [<br/>"5087f181d1dc4b14b73fdbf636498886"<br/>] |
|
||||
| `aes_itn` | *Optional[str]* | :heavy_minus_sign: | **required if eel_pfc is `AES_ITN`**<br><br/>AES / ITN reference of the shipment. | |
|
||||
| `b13a_filing_option` | [Optional[components.B13aFilingOption]](../../models/components/b13afilingoption.md) | :heavy_minus_sign: | B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). <br/><a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a> | |
|
||||
| `b13a_number` | *Optional[str]* | :heavy_minus_sign: | **must be provided if and only if b13a_filing_option is provided**<br><br/>Represents:<br> the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;<br> <br/>the Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;<br> <br/>or the Exemption Number when b13a_filing_option is `NOT_REQUIRED`. | |
|
||||
| `certificate` | *Optional[str]* | :heavy_minus_sign: | Certificate reference of the shipment. | |
|
||||
| `commercial_invoice` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `contents_explanation` | *Optional[str]* | :heavy_minus_sign: | **required if contents_type is `OTHER`**<br><br/>Explanation of the type of goods of the shipment. | T-Shirt purchase |
|
||||
| `disclaimer` | *Optional[str]* | :heavy_minus_sign: | Disclaimer for the shipment and customs information that have been provided. | |
|
||||
| `eel_pfc` | [Optional[components.EelPfc]](../../models/components/eelpfc.md) | :heavy_minus_sign: | EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most <br/>other shipments from the US, `NOEEI_30_37_a` is applicable. | NOEEI_30_37_a |
|
||||
| `exporter_reference` | *Optional[str]* | :heavy_minus_sign: | Exporter reference of an export shipment. | |
|
||||
| `importer_reference` | *Optional[str]* | :heavy_minus_sign: | Importer reference of an import shipment. | |
|
||||
| `incoterm` | [Optional[components.Incoterm]](../../models/components/incoterm.md) | :heavy_minus_sign: | The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. <br/>eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.<br/>If expecting DAP for other carriers, please use DDU. | DDP |
|
||||
| `is_vat_collected` | *Optional[Any]* | :heavy_minus_sign: | Indicates whether the shipment's destination VAT has been collected. May be required for some destinations. | |
|
||||
| `invoice` | *Optional[str]* | :heavy_minus_sign: | Invoice reference of the shipment. | #123123 |
|
||||
| `license` | *Optional[str]* | :heavy_minus_sign: | License reference of the shipment. | |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | Order ID #123123 |
|
||||
| `notes` | *Optional[str]* | :heavy_minus_sign: | Additional notes to be included in the customs declaration. | |
|
||||
| `address_importer` | [Optional[components.CustomsDeclarationAddressImporter]](../../models/components/customsdeclarationaddressimporter.md) | :heavy_minus_sign: | Object ID of the Importer address. | 257ba08436604d2aaf069caafe7acb2a |
|
||||
| `exporter_identification` | [Optional[components.CustomsExporterIdentification]](../../models/components/customsexporteridentification.md) | :heavy_minus_sign: | Additional exporter identification that may be required to ship in certain countries | |
|
||||
| `invoiced_charges` | [Optional[components.CustomsInvoicedCharges]](../../models/components/customsinvoicedcharges.md) | :heavy_minus_sign: | Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice. | |
|
||||
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of object creation. | 2014-07-17T01:01:08.306Z |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the given object. | e2197a54da9d470480f4f8796cc419cb |
|
||||
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | Username of the user who created the object. | shippotle@shippo.com |
|
||||
| `object_state` | [Optional[components.ObjectState]](../../models/components/objectstate.md) | :heavy_minus_sign: | Indicates the validity of the enclosing object | |
|
||||
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of last object update. | 2014-07-17T01:01:08.306Z |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | true |
|
||||
@@ -0,0 +1,9 @@
|
||||
# CustomsDeclarationAddressImporter
|
||||
|
||||
Object ID of the Importer address.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------- | ----------- | ----------- | ----------- |
|
||||
30
docs/models/components/customsdeclarationcreaterequest.md
Normal file
30
docs/models/components/customsdeclarationcreaterequest.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# CustomsDeclarationCreateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `certify` | *bool* | :heavy_check_mark: | Expresses that the certify_signer has provided all information of this customs declaration truthfully. | true |
|
||||
| `certify_signer` | *str* | :heavy_check_mark: | Name of the person who created the customs declaration and is responsible for the validity of all <br/>information provided. | Shawn Ippotle |
|
||||
| `contents_type` | [components.CustomsDeclarationCreateRequestContentsType](../../models/components/customsdeclarationcreaterequestcontentstype.md) | :heavy_check_mark: | Type of goods of the shipment. | MERCHANDISE |
|
||||
| `non_delivery_option` | [components.CustomsDeclarationCreateRequestNonDeliveryOption](../../models/components/customsdeclarationcreaterequestnondeliveryoption.md) | :heavy_check_mark: | Indicates how the carrier should proceed in case the shipment can't be delivered. | |
|
||||
| `items` | List[[components.CustomsItemBase](../../models/components/customsitembase.md)] | :heavy_check_mark: | N/A | |
|
||||
| `aes_itn` | *Optional[str]* | :heavy_minus_sign: | **required if eel_pfc is `AES_ITN`**<br><br/>AES / ITN reference of the shipment. | |
|
||||
| `b13a_filing_option` | [Optional[components.CustomsDeclarationCreateRequestB13aFilingOption]](../../models/components/customsdeclarationcreaterequestb13afilingoption.md) | :heavy_minus_sign: | B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS). <br/><a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a> | |
|
||||
| `b13a_number` | *Optional[str]* | :heavy_minus_sign: | **must be provided if and only if b13a_filing_option is provided**<br><br/>Represents:<br> the Proof of Report (POR) Number when b13a_filing_option is `FILED_ELECTRONICALLY`;<br> <br/>the Summary ID Number when b13a_filing_option is `SUMMARY_REPORTING`;<br> <br/>or the Exemption Number when b13a_filing_option is `NOT_REQUIRED`. | |
|
||||
| `certificate` | *Optional[str]* | :heavy_minus_sign: | Certificate reference of the shipment. | |
|
||||
| `commercial_invoice` | *Optional[str]* | :heavy_minus_sign: | N/A | |
|
||||
| `contents_explanation` | *Optional[str]* | :heavy_minus_sign: | **required if contents_type is `OTHER`**<br><br/>Explanation of the type of goods of the shipment. | T-Shirt purchase |
|
||||
| `disclaimer` | *Optional[str]* | :heavy_minus_sign: | Disclaimer for the shipment and customs information that have been provided. | |
|
||||
| `eel_pfc` | [Optional[components.CustomsDeclarationCreateRequestEelPfc]](../../models/components/customsdeclarationcreaterequesteelpfc.md) | :heavy_minus_sign: | EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most <br/>other shipments from the US, `NOEEI_30_37_a` is applicable. | NOEEI_30_37_a |
|
||||
| `exporter_reference` | *Optional[str]* | :heavy_minus_sign: | Exporter reference of an export shipment. | |
|
||||
| `importer_reference` | *Optional[str]* | :heavy_minus_sign: | Importer reference of an import shipment. | |
|
||||
| `incoterm` | [Optional[components.CustomsDeclarationCreateRequestIncoterm]](../../models/components/customsdeclarationcreaterequestincoterm.md) | :heavy_minus_sign: | The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only. <br/>eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.<br/>If expecting DAP for other carriers, please use DDU. | DDP |
|
||||
| `is_vat_collected` | *Optional[Any]* | :heavy_minus_sign: | Indicates whether the shipment's destination VAT has been collected. May be required for some destinations. | |
|
||||
| `invoice` | *Optional[str]* | :heavy_minus_sign: | Invoice reference of the shipment. | #123123 |
|
||||
| `license` | *Optional[str]* | :heavy_minus_sign: | License reference of the shipment. | |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | Order ID #123123 |
|
||||
| `notes` | *Optional[str]* | :heavy_minus_sign: | Additional notes to be included in the customs declaration. | |
|
||||
| `address_importer` | [Optional[components.AddressImporter]](../../models/components/addressimporter.md) | :heavy_minus_sign: | Object that represents the address of the importer | |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | N/A | true |
|
||||
@@ -0,0 +1,13 @@
|
||||
# CustomsDeclarationCreateRequestB13aFilingOption
|
||||
|
||||
B13A Option details are obtained by filing a B13A Canada Export Declaration via the Canadian Export Reporting System (CERS).
|
||||
<a href="https://www.cbsa-asfc.gc.ca/services/export/guide-eng.html" target="_blank" rel="noopener noreferrer"> More information on reporting commercial exports from Canada. </a>
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ---------------------- | ---------------------- |
|
||||
| `FILED_ELECTRONICALLY` | FILED_ELECTRONICALLY |
|
||||
| `SUMMARY_REPORTING` | SUMMARY_REPORTING |
|
||||
| `NOT_REQUIRED` | NOT_REQUIRED |
|
||||
@@ -0,0 +1,16 @@
|
||||
# CustomsDeclarationCreateRequestContentsType
|
||||
|
||||
Type of goods of the shipment.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----------------------- | ----------------------- |
|
||||
| `DOCUMENTS` | DOCUMENTS |
|
||||
| `GIFT` | GIFT |
|
||||
| `SAMPLE` | SAMPLE |
|
||||
| `MERCHANDISE` | MERCHANDISE |
|
||||
| `HUMANITARIAN_DONATION` | HUMANITARIAN_DONATION |
|
||||
| `RETURN_MERCHANDISE` | RETURN_MERCHANDISE |
|
||||
| `OTHER` | OTHER |
|
||||
@@ -0,0 +1,15 @@
|
||||
# CustomsDeclarationCreateRequestEelPfc
|
||||
|
||||
EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most
|
||||
other shipments from the US, `NOEEI_30_37_a` is applicable.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `NOEEI_30_37_A` | NOEEI_30_37_a |
|
||||
| `NOEEI_30_37_H` | NOEEI_30_37_h |
|
||||
| `NOEEI_30_37_F` | NOEEI_30_37_f |
|
||||
| `NOEEI_30_36` | NOEEI_30_36 |
|
||||
| `AES_ITN` | AES_ITN |
|
||||
@@ -0,0 +1,16 @@
|
||||
# CustomsDeclarationCreateRequestIncoterm
|
||||
|
||||
The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only.
|
||||
eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.
|
||||
If expecting DAP for other carriers, please use DDU.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `DDP` | DDP |
|
||||
| `DDU` | DDU |
|
||||
| `FCA` | FCA |
|
||||
| `DAP` | DAP |
|
||||
| `E_DAP` | eDAP |
|
||||
@@ -0,0 +1,11 @@
|
||||
# CustomsDeclarationCreateRequestNonDeliveryOption
|
||||
|
||||
Indicates how the carrier should proceed in case the shipment can't be delivered.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------- | --------- |
|
||||
| `ABANDON` | ABANDON |
|
||||
| `RETURN` | RETURN |
|
||||
12
docs/models/components/customsdeclarationlistwrapper.md
Normal file
12
docs/models/components/customsdeclarationlistwrapper.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# CustomsDeclarationListWrapper
|
||||
|
||||
Paginated Response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.CustomsDeclaration](../../models/components/customsdeclaration.md)] | :heavy_minus_sign: | N/A | |
|
||||
11
docs/models/components/customsexporteridentification.md
Normal file
11
docs/models/components/customsexporteridentification.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# CustomsExporterIdentification
|
||||
|
||||
Additional exporter identification that may be required to ship in certain countries
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `eori_number` | *Optional[str]* | :heavy_minus_sign: | Economic Operators' Registration and Identification (EORI) number. Must start with a 2 character <br/>country code followed by a 6-17 character alphanumeric identifier (e.g. PL1234567890ABCDE).<br/><a href="https://ec.europa.eu/taxation_customs/business/customs-procedures/general-overview/economic-operators-registration-identification-number-eori_en">More information on EORI.</a> | PL123456790ABCDE |
|
||||
| `tax_id` | [Optional[components.CustomsTaxIdentification]](../../models/components/customstaxidentification.md) | :heavy_minus_sign: | Tax identification that may be required to ship in certain countries. Typically used to assess duties on <br/>goods that are crossing a border. | |
|
||||
14
docs/models/components/customsinvoicedcharges.md
Normal file
14
docs/models/components/customsinvoicedcharges.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# CustomsInvoicedCharges
|
||||
|
||||
Additional invoiced charges to be shown on the Customs Declaration Commercial Invoice.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------- |
|
||||
| `currency` | *str* | :heavy_check_mark: | Currency for the invoiced charges amounts incurred on the end consumer. |
|
||||
| `total_shipping` | *Optional[str]* | :heavy_minus_sign: | Total shipping paid by the buyer. |
|
||||
| `total_taxes` | *Optional[str]* | :heavy_minus_sign: | Total taxes paid by the buyer. |
|
||||
| `total_duties` | *Optional[str]* | :heavy_minus_sign: | Total duties paid by the buyer. |
|
||||
| `other_fees` | *Optional[str]* | :heavy_minus_sign: | Other fees paid by the buyer. |
|
||||
24
docs/models/components/customsitem.md
Normal file
24
docs/models/components/customsitem.md
Normal file
@@ -0,0 +1,24 @@
|
||||
# CustomsItem
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `description` | *str* | :heavy_check_mark: | Text description of your item. | T-Shirt |
|
||||
| `mass_unit` | [components.WeightUnit](../../models/components/weightunit.md) | :heavy_check_mark: | The unit used for weight. | lb |
|
||||
| `net_weight` | *str* | :heavy_check_mark: | Total weight of this item, i.e. quantity * weight per item. | 5 |
|
||||
| `origin_country` | *str* | :heavy_check_mark: | Country of origin of the item. Example: `US` or `DE`. <br/>All accepted values can be found on the <a href="http://www.iso.org/" target="_blank">Official ISO Website</a>. | |
|
||||
| `quantity` | *int* | :heavy_check_mark: | Quantity of this item in the shipment you send. Must be greater than 0. | 20 |
|
||||
| `value_amount` | *str* | :heavy_check_mark: | Total value of this item, i.e. quantity * value per item. | 200 |
|
||||
| `value_currency` | *str* | :heavy_check_mark: | Currency used for value_amount. The <a href="http://www.xe.com/iso4217.php">official ISO 4217</a> <br/>currency codes are used, e.g. `USD` or `EUR`. | USD |
|
||||
| `eccn_ear99` | *Optional[str]* | :heavy_minus_sign: | Export Control Classification Number, required on some exports from the United States. | |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | Order ID "123454" |
|
||||
| `sku_code` | *Optional[str]* | :heavy_minus_sign: | SKU code of the item, which is required by some carriers. | HM-123 |
|
||||
| `tariff_number` | *Optional[str]* | :heavy_minus_sign: | The tariff number of the item. | |
|
||||
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of object creation. | 2014-07-17T00:49:20.631Z |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the given object. | d799c2679e644279b59fe661ac8fa488 |
|
||||
| `object_owner` | *Optional[str]* | :heavy_minus_sign: | Username of the user who created the object. | shippotle@shippo.com |
|
||||
| `object_state` | [Optional[components.ObjectState]](../../models/components/objectstate.md) | :heavy_minus_sign: | Indicates the validity of the enclosing object | |
|
||||
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of last object update. | 2014-07-17T00:49:20.631Z |
|
||||
| `test` | *Optional[bool]* | :heavy_minus_sign: | Indicates whether the object has been created in test mode. | |
|
||||
18
docs/models/components/customsitembase.md
Normal file
18
docs/models/components/customsitembase.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# CustomsItemBase
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `description` | *str* | :heavy_check_mark: | Text description of your item. | T-Shirt |
|
||||
| `mass_unit` | [components.WeightUnit](../../models/components/weightunit.md) | :heavy_check_mark: | The unit used for weight. | lb |
|
||||
| `net_weight` | *str* | :heavy_check_mark: | Total weight of this item, i.e. quantity * weight per item. | 5 |
|
||||
| `origin_country` | *str* | :heavy_check_mark: | Country of origin of the item. Example: `US` or `DE`. <br/>All accepted values can be found on the <a href="http://www.iso.org/" target="_blank">Official ISO Website</a>. | |
|
||||
| `quantity` | *int* | :heavy_check_mark: | Quantity of this item in the shipment you send. Must be greater than 0. | 20 |
|
||||
| `value_amount` | *str* | :heavy_check_mark: | Total value of this item, i.e. quantity * value per item. | 200 |
|
||||
| `value_currency` | *str* | :heavy_check_mark: | Currency used for value_amount. The <a href="http://www.xe.com/iso4217.php">official ISO 4217</a> <br/>currency codes are used, e.g. `USD` or `EUR`. | USD |
|
||||
| `eccn_ear99` | *Optional[str]* | :heavy_minus_sign: | Export Control Classification Number, required on some exports from the United States. | |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | A string of up to 100 characters that can be filled with any additional information you <br/>want to attach to the object. | Order ID "123454" |
|
||||
| `sku_code` | *Optional[str]* | :heavy_minus_sign: | SKU code of the item, which is required by some carriers. | HM-123 |
|
||||
| `tariff_number` | *Optional[str]* | :heavy_minus_sign: | The tariff number of the item. | |
|
||||
12
docs/models/components/customsitemlistwrapper.md
Normal file
12
docs/models/components/customsitemlistwrapper.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# CustomsItemListWrapper
|
||||
|
||||
Paginated Response
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.CustomsItem](../../models/components/customsitem.md)] | :heavy_minus_sign: | N/A | |
|
||||
12
docs/models/components/customstaxidentification.md
Normal file
12
docs/models/components/customstaxidentification.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# CustomsTaxIdentification
|
||||
|
||||
Tax identification that may be required to ship in certain countries. Typically used to assess duties on
|
||||
goods that are crossing a border.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `number` | *Optional[str]* | :heavy_minus_sign: | Tax identification number. | 123456789 |
|
||||
| `type` | [Optional[components.CustomsTaxIdentificationType]](../../models/components/customstaxidentificationtype.md) | :heavy_minus_sign: | Type of tax identification.<br/>* `EIN` - Employer Identification Number, also known as a Federal Tax Identification Number.<br/>* `VAT` - Value Added Tax identification number.<br/>* `IOSS` - Import One-Stop Shop<br/>* `ARN` - Australian Taxation Office Reference Number | EIN |
|
||||
17
docs/models/components/customstaxidentificationtype.md
Normal file
17
docs/models/components/customstaxidentificationtype.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# CustomsTaxIdentificationType
|
||||
|
||||
Type of tax identification.
|
||||
* `EIN` - Employer Identification Number, also known as a Federal Tax Identification Number.
|
||||
* `VAT` - Value Added Tax identification number.
|
||||
* `IOSS` - Import One-Stop Shop
|
||||
* `ARN` - Australian Taxation Office Reference Number
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------ | ------ |
|
||||
| `EIN` | EIN |
|
||||
| `VAT` | VAT |
|
||||
| `IOSS` | IOSS |
|
||||
| `ARN` | ARN |
|
||||
10
docs/models/components/dangerousgoodsbiologicalmaterial.md
Normal file
10
docs/models/components/dangerousgoodsbiologicalmaterial.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DangerousGoodsBiologicalMaterial
|
||||
|
||||
Container for specifying the presence of biological material.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- | ------------------------------------------------------- |
|
||||
| `contains` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the shipment contains biological material. |
|
||||
18
docs/models/components/dangerousgoodscode.md
Normal file
18
docs/models/components/dangerousgoodscode.md
Normal file
@@ -0,0 +1,18 @@
|
||||
# DangerousGoodsCode
|
||||
|
||||
Dangerous Goods Code (DHL eCommerce only). See <a href="https://api-legacy.dhlecs.com/docs/v2/appendix.html#dangerous-goods">Category Codes</a>
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `ONE` | 01 |
|
||||
| `TWO` | 02 |
|
||||
| `THREE` | 03 |
|
||||
| `FOUR` | 04 |
|
||||
| `FIVE` | 05 |
|
||||
| `SIX` | 06 |
|
||||
| `SEVEN` | 07 |
|
||||
| `EIGHT` | 08 |
|
||||
| `NINE` | 09 |
|
||||
10
docs/models/components/dangerousgoodslithiumbatteries.md
Normal file
10
docs/models/components/dangerousgoodslithiumbatteries.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# DangerousGoodsLithiumBatteries
|
||||
|
||||
Container for specifying the presence of lithium batteries.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- | ----------------------------------------------------- |
|
||||
| `contains` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the shipment contains lithium batteries. |
|
||||
14
docs/models/components/dangerousgoodsobject.md
Normal file
14
docs/models/components/dangerousgoodsobject.md
Normal file
@@ -0,0 +1,14 @@
|
||||
# DangerousGoodsObject
|
||||
|
||||
Container for specifying the presence of dangerous materials. This is specific to USPS, and if any contents
|
||||
are provided, only certain USPS service levels will be eligible. For more information, see our
|
||||
<a href="https://docs.goshippo.com/docs/shipments/hazmat/">guide on hazardous or dangerous materials shipping</a>.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `contains` | *Optional[bool]* | :heavy_minus_sign: | Indicates if the shipment contains dangerous goods. |
|
||||
| `biological_material` | [Optional[components.DangerousGoodsBiologicalMaterial]](../../models/components/dangerousgoodsbiologicalmaterial.md) | :heavy_minus_sign: | Container for specifying the presence of biological material. |
|
||||
| `lithium_batteries` | [Optional[components.DangerousGoodsLithiumBatteries]](../../models/components/dangerousgoodslithiumbatteries.md) | :heavy_minus_sign: | Container for specifying the presence of lithium batteries. |
|
||||
8
docs/models/components/defaultparceltemplate.md
Normal file
8
docs/models/components/defaultparceltemplate.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# DefaultParcelTemplate
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- |
|
||||
| `result` | [Optional[components.UserParcelTemplate]](../../models/components/userparceltemplate.md) | :heavy_minus_sign: | N/A |
|
||||
@@ -0,0 +1,8 @@
|
||||
# DefaultParcelTemplateUpdateRequest
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- | -------------------------------- |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | N/A | b958d3690bb04bb8b2986724872750f5 |
|
||||
11
docs/models/components/departmentnumber.md
Normal file
11
docs/models/components/departmentnumber.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DepartmentNumber
|
||||
|
||||
Specify the department number field on the label (FedEx only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
|
||||
| `prefix` | *Optional[str]* | :heavy_minus_sign: | Custom prefix for department number field (ZPL labels only). Up to 11 characters, including trailing <br/>spaces. Empty string indicates removal of default prefix. To use the default prefix, do not include<br/>this property. |
|
||||
| `value` | *Optional[str]* | :heavy_minus_sign: | Optional text to be printed on the shipping label for department number. Up to 40 characters. |
|
||||
15
docs/models/components/distanceunit.md
Normal file
15
docs/models/components/distanceunit.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# DistanceUnit
|
||||
|
||||
The measure unit used for length, width and height.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `CM` | cm |
|
||||
| `IN` | in |
|
||||
| `FT` | ft |
|
||||
| `M` | m |
|
||||
| `MM` | mm |
|
||||
| `YD` | yd |
|
||||
15
docs/models/components/distanceunittemplate.md
Normal file
15
docs/models/components/distanceunittemplate.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# DistanceUnitTemplate
|
||||
|
||||
The measure unit used for length, width and height. Required if template is not specified.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `CM` | cm |
|
||||
| `IN` | in |
|
||||
| `FT` | ft |
|
||||
| `M` | m |
|
||||
| `MM` | mm |
|
||||
| `YD` | yd |
|
||||
15
docs/models/components/distanceunitusertemplate.md
Normal file
15
docs/models/components/distanceunitusertemplate.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# DistanceUnitUserTemplate
|
||||
|
||||
The measure unit used for length, width and height. Required, but if using a preset carrier template then this field must be empty.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ----- | ----- |
|
||||
| `CM` | cm |
|
||||
| `IN` | in |
|
||||
| `FT` | ft |
|
||||
| `M` | m |
|
||||
| `MM` | mm |
|
||||
| `YD` | yd |
|
||||
11
docs/models/components/dryice.md
Normal file
11
docs/models/components/dryice.md
Normal file
@@ -0,0 +1,11 @@
|
||||
# DryIce
|
||||
|
||||
Specify that the package contains Dry Ice (FedEx, Veho, and UPS only).
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description |
|
||||
| ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
|
||||
| `contains_dry_ice` | *Optional[bool]* | :heavy_minus_sign: | Mandatory. Specifies that the package contains Dry Ice. |
|
||||
| `weight` | *Optional[str]* | :heavy_minus_sign: | Mandatory. Units must be in Kilograms. Cannot be greater than package weight. |
|
||||
15
docs/models/components/eelpfc.md
Normal file
15
docs/models/components/eelpfc.md
Normal file
@@ -0,0 +1,15 @@
|
||||
# EelPfc
|
||||
|
||||
EEL / PFC type of the shipment. For most shipments from the US to CA, `NOEEI_30_36` is applicable; for most
|
||||
other shipments from the US, `NOEEI_30_37_a` is applicable.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| --------------- | --------------- |
|
||||
| `NOEEI_30_37_A` | NOEEI_30_37_a |
|
||||
| `NOEEI_30_37_H` | NOEEI_30_37_h |
|
||||
| `NOEEI_30_37_F` | NOEEI_30_37_f |
|
||||
| `NOEEI_30_36` | NOEEI_30_36 |
|
||||
| `AES_ITN` | AES_ITN |
|
||||
8
docs/models/components/errormessage.md
Normal file
8
docs/models/components/errormessage.md
Normal file
@@ -0,0 +1,8 @@
|
||||
# ErrorMessage
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- | --------------------------------------------------- |
|
||||
| `shipment` | List[Dict[str, List[*str*]]] | :heavy_minus_sign: | N/A | [<br/>{<br/>"address_to": [<br/>"This field is required."<br/>]<br/>}<br/>] |
|
||||
16
docs/models/components/incoterm.md
Normal file
16
docs/models/components/incoterm.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# Incoterm
|
||||
|
||||
The incoterm reference of the shipment. FCA is available for DHL Express and FedEx only.
|
||||
eDAP is available for DPD UK only. DAP is available for DHL Express and DPD UK.
|
||||
If expecting DAP for other carriers, please use DDU.
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------- | ------- |
|
||||
| `DDP` | DDP |
|
||||
| `DDU` | DDU |
|
||||
| `FCA` | FCA |
|
||||
| `DAP` | DAP |
|
||||
| `E_DAP` | eDAP |
|
||||
12
docs/models/components/instanttransactionrequestbody.md
Normal file
12
docs/models/components/instanttransactionrequestbody.md
Normal file
@@ -0,0 +1,12 @@
|
||||
# InstantTransactionRequestBody
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `carrier_account` | *str* | :heavy_check_mark: | N/A | b741b99f95e841639b54272834bc478c |
|
||||
| `servicelevel_token` | *str* | :heavy_check_mark: | N/A | usps_priority |
|
||||
| `shipment` | [components.ShipmentCreateRequest](../../models/components/shipmentcreaterequest.md) | :heavy_check_mark: | N/A | |
|
||||
| `label_file_type` | [Optional[components.InstantTransactionRequestBodyLabelFileType]](../../models/components/instanttransactionrequestbodylabelfiletype.md) | :heavy_minus_sign: | N/A | PDF |
|
||||
| `metadata` | *Optional[str]* | :heavy_minus_sign: | N/A | Order ID #12345 |
|
||||
@@ -0,0 +1,16 @@
|
||||
# InstantTransactionRequestBodyLabelFileType
|
||||
|
||||
|
||||
## Values
|
||||
|
||||
| Name | Value |
|
||||
| ------------- | ------------- |
|
||||
| `PNG` | PNG |
|
||||
| `PNG_2_3X7_5` | PNG_2.3x7.5 |
|
||||
| `PDF` | PDF |
|
||||
| `PDF_2_3X7_5` | PDF_2.3x7.5 |
|
||||
| `PDF_4X6` | PDF_4x6 |
|
||||
| `PDF_4X8` | PDF_4x8 |
|
||||
| `PDF_A4` | PDF_A4 |
|
||||
| `PDF_A6` | PDF_A6 |
|
||||
| `ZPLII` | ZPLII |
|
||||
13
docs/models/components/insurance.md
Normal file
13
docs/models/components/insurance.md
Normal file
@@ -0,0 +1,13 @@
|
||||
# Insurance
|
||||
|
||||
To add 3rd party insurance powered by <a href="https://docs.goshippo.com/docs/shipments/shippinginsurance/">XCover</a>, specify <br> `amount`, `content`, and `currency`. <br> Alternatively, you can choose carrier provided insurance by additionally specifying `provider` (UPS, FedEx and OnTrac only). <br><br> If you do not want to add insurance to you shipment, do not set these parameters.
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `amount` | *Optional[str]* | :heavy_minus_sign: | Declared value of the goods you want to insure. | 5.5 |
|
||||
| `content` | *Optional[str]* | :heavy_minus_sign: | Description of package content. | |
|
||||
| `currency` | *Optional[str]* | :heavy_minus_sign: | Currency for the amount value.<br/>Currently only USD is supported for FedEx and UPS. | USD |
|
||||
| `provider` | [Optional[components.Provider]](../../models/components/provider.md) | :heavy_minus_sign: | To have insurance cover provided by a carrier directly instead of Shippo's provider (XCover), set `provider` to `FEDEX`, `UPS`, or `ONTRAC`. | |
|
||||
17
docs/models/components/invoice.md
Normal file
17
docs/models/components/invoice.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# Invoice
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `object_id` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the given Invoice object | ec9f0d3adc9441449c85d315f0997fd5 |
|
||||
| `object_created` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of Invoice creation. | |
|
||||
| `object_updated` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of last Invoice update. | |
|
||||
| `shippo_account` | *Optional[str]* | :heavy_minus_sign: | Unique identifier of the user who the Invoice has been issued to. | 915d94940ea54c3a80cbfa328722f5a1 |
|
||||
| `invoice_number` | *Optional[str]* | :heavy_minus_sign: | Human readable unique identifier of the given Invoice object that is displayed in the web app. | 234167 |
|
||||
| `status` | [Optional[components.InvoiceStatus]](../../models/components/invoicestatus.md) | :heavy_minus_sign: | The status of the Invoice. | POSTED |
|
||||
| `invoice_closed` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | 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` | [date](https://docs.python.org/3/library/datetime.html#date-objects) | :heavy_minus_sign: | Date and time of when the Invoice was successfully paid. Field will be null when invoice is not in the paid status. | |
|
||||
| `total_invoiced` | [Optional[components.AmountAndCurrencyInvoiced]](../../models/components/amountandcurrencyinvoiced.md) | :heavy_minus_sign: | The amount and currency. | |
|
||||
| `total_charged` | [Optional[components.AmountAndCurrencyCharged]](../../models/components/amountandcurrencycharged.md) | :heavy_minus_sign: | The amount and currency that was charged after possible currency conversion occurred. | |
|
||||
18
docs/models/components/invoiceitem.md
Normal file
18
docs/models/components/invoiceitem.md
Normal file
File diff suppressed because one or more lines are too long
10
docs/models/components/invoiceitemlistwrapper.md
Normal file
10
docs/models/components/invoiceitemlistwrapper.md
Normal file
@@ -0,0 +1,10 @@
|
||||
# InvoiceItemListWrapper
|
||||
|
||||
|
||||
## Fields
|
||||
|
||||
| Field | Type | Required | Description | Example |
|
||||
| ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- | ---------------------------------------------------------------------- |
|
||||
| `next` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=3&results=10 |
|
||||
| `previous` | *Optional[str]* | :heavy_minus_sign: | N/A | baseurl?page=1&results=10 |
|
||||
| `results` | List[[components.InvoiceItem](../../models/components/invoiceitem.md)] | :heavy_minus_sign: | N/A | |
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user