{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:shippo/addresses-list-all":{"get":{"operationId":"open_data_shippo_addresses_list_all","summary":"List all addresses","description":"GET /addresses","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100, default 5)","schema":{"type":"integer","default":5,"description":"The number of results to return per page (max 100, default 5)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/addresses-create-new-address":{"post":{"operationId":"open_data_shippo_addresses_create_new_address","summary":"Create a new address","description":"POST /addresses","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/addresses-get-address-by-id":{"get":{"operationId":"open_data_shippo_addresses_get_address_by_id","summary":"Retrieve an address","description":"GET /addresses/{AddressId}","tags":["open-data"],"parameters":[{"name":"AddressId","in":"query","required":true,"description":"Object ID of the address","schema":{"type":"string","description":"Object ID of the address"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/addresses-validate-address":{"get":{"operationId":"open_data_shippo_addresses_validate_address","summary":"Validate an address","description":"GET /addresses/{AddressId}/validate","tags":["open-data"],"parameters":[{"name":"AddressId","in":"query","required":true,"description":"Object ID of the address","schema":{"type":"string","description":"Object ID of the address"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/batches-create-batch-shipments":{"post":{"operationId":"open_data_shippo_batches_create_batch_shipments","summary":"Create a batch","description":"POST /batches","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/batches-get-batch-by-id":{"get":{"operationId":"open_data_shippo_batches_get_batch_by_id","summary":"Retrieve a batch","description":"GET /batches/{BatchId}","tags":["open-data"],"parameters":[{"name":"BatchId","in":"query","required":true,"description":"Object ID of the batch","schema":{"type":"string","description":"Object ID of the batch"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/batches-add-shipments-to-batch":{"post":{"operationId":"open_data_shippo_batches_add_shipments_to_batch","summary":"Add shipments to a batch","description":"POST /batches/{BatchId}/add_shipments","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId"],"properties":{"BatchId":{"type":"string","description":"Object ID of the batch"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/batches-purchase-batch":{"post":{"operationId":"open_data_shippo_batches_purchase_batch","summary":"Purchase a batch","description":"POST /batches/{BatchId}/purchase","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId"],"properties":{"BatchId":{"type":"string","description":"Object ID of the batch"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/batches-remove-shipments":{"post":{"operationId":"open_data_shippo_batches_remove_shipments","summary":"Remove shipments from a batch","description":"POST /batches/{BatchId}/remove_shipments","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["BatchId"],"properties":{"BatchId":{"type":"string","description":"Object ID of the batch"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-list-all-accounts":{"get":{"operationId":"open_data_shippo_carrier_accounts_list_all_accounts","summary":"List all carrier accounts","description":"GET /carrier_accounts","tags":["open-data"],"parameters":[{"name":"service_levels","in":"query","required":false,"description":"Appends the property `service_levels` to each returned carrier account","schema":{"type":"boolean","description":"Appends the property `service_levels` to each returned carrier account"}},{"name":"carrier","in":"query","required":false,"description":"Filter the response by the specified carrier","schema":{"type":"string","description":"Filter the response by the specified carrier"}},{"name":"account_id","in":"query","required":false,"description":"Filter the response by the specified carrier account Id","schema":{"type":"string","description":"Filter the response by the specified carrier account Id"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100, default 5)","schema":{"type":"integer","default":5,"description":"The number of results to return per page (max 100, default 5)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-create-new-account":{"post":{"operationId":"open_data_shippo_carrier_accounts_create_new_account","summary":"Create a new carrier account","description":"POST /carrier_accounts","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-get-account-by-id":{"get":{"operationId":"open_data_shippo_carrier_accounts_get_account_by_id","summary":"Retrieve a carrier account","description":"GET /carrier_accounts/{CarrierAccountId}","tags":["open-data"],"parameters":[{"name":"CarrierAccountId","in":"query","required":true,"description":"Object ID of the carrier account","schema":{"type":"string","description":"Object ID of the carrier account"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-update-account":{"post":{"operationId":"open_data_shippo_carrier_accounts_update_account","summary":"Update a carrier account","description":"PUT /carrier_accounts/{CarrierAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["CarrierAccountId"],"properties":{"CarrierAccountId":{"type":"string","description":"Object ID of the carrier account"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-initiate-sign-in":{"get":{"operationId":"open_data_shippo_carrier_accounts_initiate_sign_in","summary":"Connect an existing carrier account using OAuth 2.0","description":"GET /carrier_accounts/{CarrierAccountObjectId}/signin/initiate","tags":["open-data"],"parameters":[{"name":"CarrierAccountObjectId","in":"query","required":true,"description":"The carrier account ID to start a signin process","schema":{"type":"string","description":"The carrier account ID to start a signin process"}},{"name":"redirect_uri","in":"query","required":true,"description":"Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request.","schema":{"type":"string","description":"Callback URL. The URL that tells the authorization server where to send the user back to after they approve the request."}},{"name":"state","in":"query","required":false,"description":"A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application…","schema":{"type":"string","description":"A random string generated by the consuming application and included in the request to prevent CSRF attacks. The consuming application…"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-add-shippo-account":{"post":{"operationId":"open_data_shippo_carrier_accounts_add_shippo_account","summary":"Add a Shippo carrier account","description":"POST /carrier_accounts/register/new","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-accounts-get-reg-status":{"get":{"operationId":"open_data_shippo_carrier_accounts_get_reg_status","summary":"Get Carrier Registration status","description":"GET /carrier_accounts/reg-status","tags":["open-data"],"parameters":[{"name":"carrier","in":"query","required":true,"description":"filter by specific carrier","schema":{"type":"string","enum":["ups","usps","canada_post"],"description":"filter by specific carrier"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-declarations-list-all-declarations":{"get":{"operationId":"open_data_shippo_customs_declarations_list_all_declarations","summary":"List all customs declarations","description":"GET /customs/declarations","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100, default 5)","schema":{"type":"integer","default":5,"description":"The number of results to return per page (max 100, default 5)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-declarations-create-new-declaration":{"post":{"operationId":"open_data_shippo_customs_declarations_create_new_declaration","summary":"Create a new customs declaration","description":"POST /customs/declarations","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-declarations-get-declaration-by-id":{"get":{"operationId":"open_data_shippo_customs_declarations_get_declaration_by_id","summary":"Retrieve a customs declaration","description":"GET /customs/declarations/{CustomsDeclarationId}","tags":["open-data"],"parameters":[{"name":"CustomsDeclarationId","in":"query","required":true,"description":"Object ID of the customs declaration","schema":{"type":"string","description":"Object ID of the customs declaration"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-items-list-all-items":{"get":{"operationId":"open_data_shippo_customs_items_list_all_items","summary":"List all customs items","description":"GET /customs/items","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-items-create-new-customs-item":{"post":{"operationId":"open_data_shippo_customs_items_create_new_customs_item","summary":"Create a new customs item","description":"POST /customs/items","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/customs-items-get-existing-item":{"get":{"operationId":"open_data_shippo_customs_items_get_existing_item","summary":"Retrieve a customs item","description":"GET /customs/items/{CustomsItemId}","tags":["open-data"],"parameters":[{"name":"CustomsItemId","in":"query","required":true,"description":"Object ID of the customs item","schema":{"type":"string","description":"Object ID of the customs item"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-at-checkout-initiate-live-rates-request":{"post":{"operationId":"open_data_shippo_rates_at_checkout_initiate_live_rates_request","summary":"Generate a live rates request","description":"POST /live-rates","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-at-checkout-show-default-parcel-template":{"get":{"operationId":"open_data_shippo_rates_at_checkout_show_default_parcel_template","summary":"Show current default parcel template","description":"GET /live-rates/settings/parcel-template","tags":["open-data"],"parameters":[{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-at-checkout-update-default-parcel-template":{"post":{"operationId":"open_data_shippo_rates_at_checkout_update_default_parcel_template","summary":"Update default parcel template","description":"PUT /live-rates/settings/parcel-template","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-at-checkout-clear-default-parcel-template":{"post":{"operationId":"open_data_shippo_rates_at_checkout_clear_default_parcel_template","summary":"Clear current default parcel template","description":"DELETE /live-rates/settings/parcel-template","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/manifests-list-all-manifests":{"get":{"operationId":"open_data_shippo_manifests_list_all_manifests","summary":"List all manifests","description":"GET /manifests","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100, default 5)","schema":{"type":"integer","default":5,"description":"The number of results to return per page (max 100, default 5)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/manifests-create-new-manifest":{"post":{"operationId":"open_data_shippo_manifests_create_new_manifest","summary":"Create a new manifest","description":"POST /manifests","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/manifests-get-manifest-by-id":{"get":{"operationId":"open_data_shippo_manifests_get_manifest_by_id","summary":"Retrieve a manifest","description":"GET /manifests/{ManifestId}","tags":["open-data"],"parameters":[{"name":"ManifestId","in":"query","required":true,"description":"Object ID of the manifest to update","schema":{"type":"string","description":"Object ID of the manifest to update"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/orders-list-all-orders":{"get":{"operationId":"open_data_shippo_orders_list_all_orders","summary":"List all orders","description":"GET /orders","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/orders-create-new-order":{"post":{"operationId":"open_data_shippo_orders_create_new_order","summary":"Create a new order","description":"POST /orders","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/orders-get-order-by-id":{"get":{"operationId":"open_data_shippo_orders_get_order_by_id","summary":"Retrieve an order","description":"GET /orders/{OrderId}","tags":["open-data"],"parameters":[{"name":"OrderId","in":"query","required":true,"description":"Object ID of the order","schema":{"type":"string","description":"Object ID of the order"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-parcel-templates-list-all-carrier-parcel-templates":{"get":{"operationId":"open_data_shippo_carrier_parcel_templates_list_all_carrier_parcel_templates","summary":"List all carrier parcel templates","description":"GET /parcel-templates","tags":["open-data"],"parameters":[{"name":"include","in":"query","required":false,"description":"filter by user or enabled","schema":{"type":"string","enum":["all","user","enabled"],"description":"filter by user or enabled"}},{"name":"carrier","in":"query","required":false,"description":"filter by specific carrier","schema":{"type":"string","description":"filter by specific carrier"},"example":"fedex"},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/carrier-parcel-templates-get-template-by-id":{"get":{"operationId":"open_data_shippo_carrier_parcel_templates_get_template_by_id","summary":"Retrieve a carrier parcel templates","description":"GET /parcel-templates/{CarrierParcelTemplateToken}","tags":["open-data"],"parameters":[{"name":"CarrierParcelTemplateToken","in":"query","required":true,"description":"The unique string representation of the carrier parcel template","schema":{"type":"string","description":"The unique string representation of the carrier parcel template"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/parcels-list-all":{"get":{"operationId":"open_data_shippo_parcels_list_all","summary":"List all parcels","description":"GET /parcels","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/parcels-create-new-parcel":{"post":{"operationId":"open_data_shippo_parcels_create_new_parcel","summary":"Create a new parcel","description":"POST /parcels","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/parcels-get-parcel-details":{"get":{"operationId":"open_data_shippo_parcels_get_parcel_details","summary":"Retrieve an existing parcel","description":"GET /parcels/{ParcelId}","tags":["open-data"],"parameters":[{"name":"ParcelId","in":"query","required":true,"description":"Object ID of the parcel","schema":{"type":"string","description":"Object ID of the parcel"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/pickups-create-object":{"post":{"operationId":"open_data_shippo_pickups_create_object","summary":"Create a pickup","description":"POST /pickups","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-get-rate-by-id":{"get":{"operationId":"open_data_shippo_rates_get_rate_by_id","summary":"Retrieve a rate","description":"GET /rates/{RateId}","tags":["open-data"],"parameters":[{"name":"RateId","in":"query","required":true,"description":"Object ID of the rate","schema":{"type":"string","description":"Object ID of the rate"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/refunds-list-all":{"get":{"operationId":"open_data_shippo_refunds_list_all","summary":"List all refunds","description":"GET /refunds","tags":["open-data"],"parameters":[{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/refunds-get-refund-by-id":{"get":{"operationId":"open_data_shippo_refunds_get_refund_by_id","summary":"Retrieve a refund","description":"GET /refunds/{RefundId}","tags":["open-data"],"parameters":[{"name":"RefundId","in":"query","required":true,"description":"Object ID of the refund to update","schema":{"type":"string","description":"Object ID of the refund to update"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/service-groups-list-all-service-groups":{"get":{"operationId":"open_data_shippo_service_groups_list_all_service_groups","summary":"List all service groups","description":"GET /service-groups","tags":["open-data"],"parameters":[{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/service-groups-create-new-group":{"post":{"operationId":"open_data_shippo_service_groups_create_new_group","summary":"Create a new service group","description":"POST /service-groups","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/service-groups-update-existing-group":{"post":{"operationId":"open_data_shippo_service_groups_update_existing_group","summary":"Update an existing service group","description":"PUT /service-groups","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/service-groups-delete-service-group":{"post":{"operationId":"open_data_shippo_service_groups_delete_service_group","summary":"Delete a service group","description":"DELETE /service-groups/{ServiceGroupId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ServiceGroupId"],"properties":{"ServiceGroupId":{"type":"string","description":"Object ID of the service group"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shipments-list-all-shipments":{"get":{"operationId":"open_data_shippo_shipments_list_all_shipments","summary":"List all shipments","description":"GET /shipments","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shipments-create-new-shipment":{"post":{"operationId":"open_data_shippo_shipments_create_new_shipment","summary":"Create a new shipment","description":"POST /shipments","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shipments-get-shipment-by-id":{"get":{"operationId":"open_data_shippo_shipments_get_shipment_by_id","summary":"Retrieve a shipment","description":"GET /shipments/{ShipmentId}","tags":["open-data"],"parameters":[{"name":"ShipmentId","in":"query","required":true,"description":"Object ID of the shipment to update","schema":{"type":"string","description":"Object ID of the shipment to update"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-get-shipment-rates":{"get":{"operationId":"open_data_shippo_rates_get_shipment_rates","summary":"Retrieve shipment rates","description":"GET /shipments/{ShipmentId}/rates","tags":["open-data"],"parameters":[{"name":"ShipmentId","in":"query","required":true,"description":"Object ID of the shipment to update","schema":{"type":"string","description":"Object ID of the shipment to update"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/rates-get-shipment-rates-in-currency":{"get":{"operationId":"open_data_shippo_rates_get_shipment_rates_in_currency","summary":"Retrieve shipment rates in currency","description":"GET /shipments/{ShipmentId}/rates/{CurrencyCode}","tags":["open-data"],"parameters":[{"name":"ShipmentId","in":"query","required":true,"description":"Object ID of the shipment to update","schema":{"type":"string","description":"Object ID of the shipment to update"}},{"name":"CurrencyCode","in":"query","required":true,"description":"ISO currency code for the rates","schema":{"type":"string","default":"USD","description":"ISO currency code for the rates"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/tracking-status-register-webhook":{"post":{"operationId":"open_data_shippo_tracking_status_register_webhook","summary":"Register a tracking webhook","description":"POST /tracks","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/tracking-status-get-status":{"get":{"operationId":"open_data_shippo_tracking_status_get_status","summary":"Get a tracking status","description":"GET /tracks/{Carrier}/{TrackingNumber}","tags":["open-data"],"parameters":[{"name":"TrackingNumber","in":"query","required":true,"description":"Tracking number","schema":{"type":"string","description":"Tracking number"}},{"name":"Carrier","in":"query","required":true,"description":"Name of the carrier","schema":{"type":"string","description":"Name of the carrier"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/transactions-list-all-shipping-labels":{"get":{"operationId":"open_data_shippo_transactions_list_all_shipping_labels","summary":"List all shipping labels","description":"GET /transactions","tags":["open-data"],"parameters":[{"name":"rate","in":"query","required":false,"description":"Filter by rate ID","schema":{"type":"string","description":"Filter by rate ID"}},{"name":"object_status","in":"query","required":false,"description":"Filter by object status","schema":{"type":"string","enum":["WAITING","QUEUED","SUCCESS","ERROR","REFUNDED","REFUNDPENDING","REFUNDREJECTED"],"description":"Filter by object status"}},{"name":"tracking_status","in":"query","required":false,"description":"Filter by tracking status","schema":{"type":"string","enum":["UNKNOWN","PRE_TRANSIT","TRANSIT","DELIVERED","RETURNED","FAILURE"],"description":"Filter by tracking status"}},{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/transactions-create-shipping-label":{"post":{"operationId":"open_data_shippo_transactions_create_shipping_label","summary":"Create a shipping label","description":"POST /transactions","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/transactions-get-shipping-label":{"get":{"operationId":"open_data_shippo_transactions_get_shipping_label","summary":"Retrieve a shipping label","description":"GET /transactions/{TransactionId}","tags":["open-data"],"parameters":[{"name":"TransactionId","in":"query","required":true,"description":"Object ID of the transaction to update","schema":{"type":"string","description":"Object ID of the transaction to update"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/user-parcel-templates-list-all":{"get":{"operationId":"open_data_shippo_user_parcel_templates_list_all","summary":"List all user parcel templates","description":"GET /user-parcel-templates","tags":["open-data"],"parameters":[{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/user-parcel-templates-create-new-template":{"post":{"operationId":"open_data_shippo_user_parcel_templates_create_new_template","summary":"Create a new user parcel template","description":"POST /user-parcel-templates","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/user-parcel-templates-get-template-by-id":{"get":{"operationId":"open_data_shippo_user_parcel_templates_get_template_by_id","summary":"Retrieves a user parcel template","description":"GET /user-parcel-templates/{UserParcelTemplateObjectId}","tags":["open-data"],"parameters":[{"name":"UserParcelTemplateObjectId","in":"query","required":true,"description":"Object ID of the user parcel template","schema":{"type":"string","description":"Object ID of the user parcel template"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/user-parcel-templates-update-template":{"post":{"operationId":"open_data_shippo_user_parcel_templates_update_template","summary":"Update an existing user parcel template","description":"PUT /user-parcel-templates/{UserParcelTemplateObjectId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserParcelTemplateObjectId"],"properties":{"UserParcelTemplateObjectId":{"type":"string","description":"Object ID of the user parcel template"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/user-parcel-templates-delete-by-id":{"post":{"operationId":"open_data_shippo_user_parcel_templates_delete_by_id","summary":"Delete a user parcel template","description":"DELETE /user-parcel-templates/{UserParcelTemplateObjectId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["UserParcelTemplateObjectId"],"properties":{"UserParcelTemplateObjectId":{"type":"string","description":"Object ID of the user parcel template"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shippo-accounts-list-all":{"get":{"operationId":"open_data_shippo_shippo_accounts_list_all","summary":"List all Shippo Accounts","description":"GET /shippo-accounts","tags":["open-data"],"parameters":[{"name":"page","in":"query","required":false,"description":"The page number you want to select","schema":{"type":"integer","default":1,"description":"The page number you want to select"}},{"name":"results","in":"query","required":false,"description":"The number of results to return per page (max 100)","schema":{"type":"integer","default":25,"description":"The number of results to return per page (max 100)"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shippo-accounts-create-new-account":{"post":{"operationId":"open_data_shippo_shippo_accounts_create_new_account","summary":"Create a Shippo Account","description":"POST /shippo-accounts","tags":["open-data"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shippo-accounts-get-account-by-id":{"get":{"operationId":"open_data_shippo_shippo_accounts_get_account_by_id","summary":"Retrieve a Shippo Account","description":"GET /shippo-accounts/{ShippoAccountId}","tags":["open-data"],"parameters":[{"name":"ShippoAccountId","in":"query","required":true,"description":"Object ID of the ShippoAccount","schema":{"type":"string","description":"Object ID of the ShippoAccount"}},{"name":"SHIPPO-API-VERSION","in":"query","required":false,"description":"String used to pick a non-default API version to use","schema":{"type":"string","description":"String used to pick a non-default API version to use"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"byok"}},"/v1/open-data:shippo/shippo-accounts-update-account-object":{"post":{"operationId":"open_data_shippo_shippo_accounts_update_account_object","summary":"Update a Shippo Account","description":"PUT /shippo-accounts/{ShippoAccountId}","tags":["open-data"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ShippoAccountId"],"properties":{"ShippoAccountId":{"type":"string","description":"Object ID of the ShippoAccount"},"SHIPPO-API-VERSION":{"type":"string","description":"String used to pick a non-default API version to use"},"body":{"type":"object","description":"JSON request body"}}}}}},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":0,"x-apizie-min-plan":null,"x-apizie-bulk":false,"x-apizie-status":"byok"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}