{"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/transport:shipengine/account-list-settings":{"get":{"operationId":"transport_shipengine_account_list_settings","summary":"List Account Settings","description":"GET /v1/account/settings","tags":["transport"],"parameters":[],"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/transport:shipengine/account-list-images":{"get":{"operationId":"transport_shipengine_account_list_images","summary":"List Account Images","description":"GET /v1/account/settings/images","tags":["transport"],"parameters":[],"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/transport:shipengine/account-create-image":{"post":{"operationId":"transport_shipengine_account_create_image","summary":"Create an Account Image","description":"POST /v1/account/settings/images","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/account-get-image-by-id":{"get":{"operationId":"transport_shipengine_account_get_image_by_id","summary":"Get Account Image By ID","description":"GET /v1/account/settings/images/{label_image_id}","tags":["transport"],"parameters":[{"name":"label_image_id","in":"query","required":true,"description":"Label Image Id","schema":{"type":"string","description":"Label Image Id"}}],"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/transport:shipengine/account-update-image-by-id":{"post":{"operationId":"transport_shipengine_account_update_image_by_id","summary":"Update Account Image By ID","description":"PUT /v1/account/settings/images/{label_image_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label_image_id","body"],"properties":{"label_image_id":{"type":"string","description":"Label Image Id"},"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/transport:shipengine/account-delete-image-by-id":{"post":{"operationId":"transport_shipengine_account_delete_image_by_id","summary":"Delete Account Image By Id","description":"DELETE /v1/account/settings/images/{label_image_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label_image_id"],"properties":{"label_image_id":{"type":"string","description":"Label Image Id"}}}}}},"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/transport:shipengine/parse-address":{"post":{"operationId":"transport_shipengine_parse_address","summary":"Parse an address","description":"PUT /v1/addresses/recognize","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/validate-address":{"post":{"operationId":"transport_shipengine_validate_address","summary":"Validate An Address","description":"POST /v1/addresses/validate","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/list-batches":{"get":{"operationId":"transport_shipengine_list_batches","summary":"List Batches","description":"GET /v1/batches","tags":["transport"],"parameters":[{"name":"status","in":"query","required":false,"description":"The possible batch status values","schema":{"type":"string","enum":["open","queued","processing","completed","completed_with_errors","archived","notifying","invalid"],"description":"The possible batch status values"}},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"page_size","in":"query","required":false,"description":"The number of results to return per response.","schema":{"type":"integer","default":25,"description":"The number of results to return per response."},"example":50},{"name":"sort_dir","in":"query","required":false,"description":"Controls the sort order of the query.","schema":{"type":"string","enum":["asc","desc"],"description":"Controls the sort order of the query."}},{"name":"batch_number","in":"query","required":false,"description":"Batch Number","schema":{"type":"string","description":"Batch Number"}},{"name":"sort_by","in":"query","required":false,"description":"The possible batches sort by values","schema":{"type":"string","enum":["ship_date","processed_at","created_at"],"description":"The possible batches sort by values"}}],"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/transport:shipengine/create-batch":{"post":{"operationId":"transport_shipengine_create_batch","summary":"Create A Batch","description":"POST /v1/batches","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/batches-get-by-external-id":{"get":{"operationId":"transport_shipengine_batches_get_by_external_id","summary":"Get Batch By External ID","description":"GET /v1/batches/external_batch_id/{external_batch_id}","tags":["transport"],"parameters":[{"name":"external_batch_id","in":"query","required":true,"schema":{"type":"string"},"example":"13553d7f-3c87-4771-bae1-c49bacef11cb"}],"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/transport:shipengine/batches-get-by-id":{"get":{"operationId":"transport_shipengine_batches_get_by_id","summary":"Get Batch By ID","description":"GET /v1/batches/{batch_id}","tags":["transport"],"parameters":[{"name":"batch_id","in":"query","required":true,"description":"Batch ID","schema":{"type":"string","description":"Batch ID"}}],"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/transport:shipengine/update-batch":{"post":{"operationId":"transport_shipengine_update_batch","summary":"Update Batch By Id","description":"PUT /v1/batches/{batch_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id"],"properties":{"batch_id":{"type":"string","description":"Batch ID"}}}}}},"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/transport:shipengine/delete-batch":{"post":{"operationId":"transport_shipengine_delete_batch","summary":"Delete Batch By Id","description":"DELETE /v1/batches/{batch_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id"],"properties":{"batch_id":{"type":"string","description":"Batch ID"}}}}}},"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/transport:shipengine/batches-add-to-batch":{"post":{"operationId":"transport_shipengine_batches_add_to_batch","summary":"Add to a Batch","description":"POST /v1/batches/{batch_id}/add","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id","body"],"properties":{"batch_id":{"type":"string","description":"Batch ID"},"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/transport:shipengine/batches-get-errors":{"get":{"operationId":"transport_shipengine_batches_get_errors","summary":"Get Batch Errors","description":"GET /v1/batches/{batch_id}/errors","tags":["transport"],"parameters":[{"name":"batch_id","in":"query","required":true,"description":"Batch ID","schema":{"type":"string","description":"Batch ID"}},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"pagesize","in":"query","required":false,"schema":{"type":"integer"}}],"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/transport:shipengine/process-batch":{"post":{"operationId":"transport_shipengine_process_batch","summary":"Process Batch ID Labels","description":"POST /v1/batches/{batch_id}/process/labels","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id","body"],"properties":{"batch_id":{"type":"string","description":"Batch ID"},"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/transport:shipengine/batches-remove-from-batch":{"post":{"operationId":"transport_shipengine_batches_remove_from_batch","summary":"Remove From Batch","description":"POST /v1/batches/{batch_id}/remove","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["batch_id","body"],"properties":{"batch_id":{"type":"string","description":"Batch ID"},"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/transport:shipengine/list-carriers":{"get":{"operationId":"transport_shipengine_list_carriers","summary":"List Carriers","description":"GET /v1/carriers","tags":["transport"],"parameters":[],"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/transport:shipengine/carriers-get-by-id":{"get":{"operationId":"transport_shipengine_carriers_get_by_id","summary":"Get Carrier By ID","description":"GET /v1/carriers/{carrier_id}","tags":["transport"],"parameters":[{"name":"carrier_id","in":"query","required":true,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"},"example":"se-28529731"}],"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/transport:shipengine/carriers-disconnect-by-id":{"post":{"operationId":"transport_shipengine_carriers_disconnect_by_id","summary":"Disconnect Carrier by ID","description":"DELETE /v1/carriers/{carrier_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carrier_id"],"properties":{"carrier_id":{"type":"string","description":"Carrier ID"}}}}}},"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/transport:shipengine/carriers-add-funds-to-carrier":{"post":{"operationId":"transport_shipengine_carriers_add_funds_to_carrier","summary":"Add Funds To Carrier","description":"PUT /v1/carriers/{carrier_id}/add_funds","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carrier_id","body"],"properties":{"carrier_id":{"type":"string","description":"Carrier ID"},"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/transport:shipengine/carriers-get-options":{"get":{"operationId":"transport_shipengine_carriers_get_options","summary":"Get Carrier Options","description":"GET /v1/carriers/{carrier_id}/options","tags":["transport"],"parameters":[{"name":"carrier_id","in":"query","required":true,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"},"example":"se-28529731"}],"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/transport:shipengine/carriers-list-package-types":{"get":{"operationId":"transport_shipengine_carriers_list_package_types","summary":"List Carrier Package Types","description":"GET /v1/carriers/{carrier_id}/packages","tags":["transport"],"parameters":[{"name":"carrier_id","in":"query","required":true,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"},"example":"se-28529731"}],"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/transport:shipengine/carriers-list-services":{"get":{"operationId":"transport_shipengine_carriers_list_services","summary":"List Carrier Services","description":"GET /v1/carriers/{carrier_id}/services","tags":["transport"],"parameters":[{"name":"carrier_id","in":"query","required":true,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"},"example":"se-28529731"}],"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/transport:shipengine/connect-carrier":{"post":{"operationId":"transport_shipengine_connect_carrier","summary":"Connect a carrier account","description":"POST /v1/connections/carriers/{carrier_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carrier_name","body"],"properties":{"carrier_name":{"type":"string","enum":["access_worldwide","amazon_buy_shipping","amazon_shipping_uk","apc","asendia","australia_post","canada_post","dhl_ecommerce","dhl_express","dhl_express_au","dhl_express_ca","dhl_express_uk","dpd","endicia","fedex","fedex_uk","firstmile","imex","newgistics","ontrac","purolator_canada","royal_mail","rr_donnelley","seko","sendle","stamps_com","ups"],"description":"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`."},"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/transport:shipengine/disconnect-carrier":{"post":{"operationId":"transport_shipengine_disconnect_carrier","summary":"Disconnect a carrier","description":"DELETE /v1/connections/carriers/{carrier_name}/{carrier_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carrier_name","carrier_id"],"properties":{"carrier_name":{"type":"string","enum":["access_worldwide","amazon_buy_shipping","amazon_shipping_uk","apc","asendia","australia_post","canada_post","dhl_ecommerce","dhl_express","dhl_express_au","dhl_express_ca","dhl_express_uk","dpd","endicia","fedex","fedex_uk","firstmile","imex","newgistics","ontrac","purolator_canada","royal_mail","rr_donnelley","seko","sendle","stamps_com","ups"],"description":"The carrier name, such as `stamps_com`, `ups`, `fedex`, or `dhl_express`."},"carrier_id":{"type":"string","description":"Carrier ID"}}}}}},"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/transport:shipengine/carrieraccounts-get-settings":{"get":{"operationId":"transport_shipengine_carrieraccounts_get_settings","summary":"Get carrier settings","description":"GET /v1/connections/carriers/{carrier_name}/{carrier_id}/settings","tags":["transport"],"parameters":[{"name":"carrier_name","in":"query","required":true,"description":"The carrier name, such as `ups`, `fedex`, or `dhl_express`.","schema":{"type":"string","enum":["dhl_express","fedex","newgistics","ups"],"description":"The carrier name, such as `ups`, `fedex`, or `dhl_express`."},"example":"dhl_express"},{"name":"carrier_id","in":"query","required":true,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"},"example":"se-28529731"}],"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/transport:shipengine/carrieraccounts-update-settings":{"post":{"operationId":"transport_shipengine_carrieraccounts_update_settings","summary":"Update carrier settings","description":"PUT /v1/connections/carriers/{carrier_name}/{carrier_id}/settings","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["carrier_name","carrier_id","body"],"properties":{"carrier_name":{"type":"string","enum":["dhl_express","fedex","newgistics","ups"],"description":"The carrier name, such as `ups`, `fedex`, or `dhl_express`."},"carrier_id":{"type":"string","description":"Carrier ID"},"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/transport:shipengine/connect-insurer":{"post":{"operationId":"transport_shipengine_connect_insurer","summary":"Connect a Shipsurance Account","description":"POST /v1/connections/insurance/shipsurance","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/disconnect-insurer":{"post":{"operationId":"transport_shipengine_disconnect_insurer","summary":"Disconnect a Shipsurance Account","description":"DELETE /v1/connections/insurance/shipsurance","tags":["transport"],"parameters":[],"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/transport:shipengine/download-file":{"get":{"operationId":"transport_shipengine_download_file","summary":"Download File","description":"GET /v1/downloads/{dir}/{subdir}/{filename}","tags":["transport"],"parameters":[{"name":"subdir","in":"query","required":true,"schema":{"type":"string"}},{"name":"filename","in":"query","required":true,"schema":{"type":"string"}},{"name":"dir","in":"query","required":true,"schema":{"type":"string"}},{"name":"download","in":"query","required":false,"schema":{"type":"string"}},{"name":"rotation","in":"query","required":false,"schema":{"type":"integer"}}],"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/transport:shipengine/list-webhooks":{"get":{"operationId":"transport_shipengine_list_webhooks","summary":"List Webhooks","description":"GET /v1/environment/webhooks","tags":["transport"],"parameters":[],"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/transport:shipengine/create-webhook":{"post":{"operationId":"transport_shipengine_create_webhook","summary":"Create a Webhook","description":"POST /v1/environment/webhooks","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/webhooks-get-by-id":{"get":{"operationId":"transport_shipengine_webhooks_get_by_id","summary":"Get Webhook By ID","description":"GET /v1/environment/webhooks/{webhook_id}","tags":["transport"],"parameters":[{"name":"webhook_id","in":"query","required":true,"description":"Webhook ID","schema":{"type":"string","description":"Webhook ID"}}],"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/transport:shipengine/update-webhook":{"post":{"operationId":"transport_shipengine_update_webhook","summary":"Update a Webhook","description":"PUT /v1/environment/webhooks/{webhook_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id","body"],"properties":{"webhook_id":{"type":"string","description":"Webhook ID"},"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/transport:shipengine/delete-webhook":{"post":{"operationId":"transport_shipengine_delete_webhook","summary":"Delete Webhook By ID","description":"DELETE /v1/environment/webhooks/{webhook_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["webhook_id"],"properties":{"webhook_id":{"type":"string","description":"Webhook ID"}}}}}},"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/transport:shipengine/insurance-auto-fund-account":{"post":{"operationId":"transport_shipengine_insurance_auto_fund_account","summary":"Add Funds To Insurance","description":"PATCH /v1/insurance/shipsurance/add_funds","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/insurance-get-funds-balance":{"get":{"operationId":"transport_shipengine_insurance_get_funds_balance","summary":"Get Insurance Funds Balance","description":"GET /v1/insurance/shipsurance/balance","tags":["transport"],"parameters":[],"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/transport:shipengine/list-labels":{"get":{"operationId":"transport_shipengine_list_labels","summary":"List labels","description":"GET /v1/labels","tags":["transport"],"parameters":[{"name":"label_status","in":"query","required":false,"description":"Only return labels that are currently in the specified status","schema":{"type":"string","enum":["processing","completed","error","voided"],"description":"Only return labels that are currently in the specified status"}},{"name":"service_code","in":"query","required":false,"description":"Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)","schema":{"type":"string","description":"Only return labels for a specific [carrier service](https://www.shipengine.com/docs/shipping/use-a-carrier-service/)"},"example":"usps_first_class_mail"},{"name":"carrier_id","in":"query","required":false,"description":"Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)","schema":{"type":"string","description":"Only return labels for a specific [carrier account](https://www.shipengine.com/docs/carriers/setup/)"}},{"name":"tracking_number","in":"query","required":false,"description":"Only return labels with a specific tracking number","schema":{"type":"string","description":"Only return labels with a specific tracking number"},"example":"9405511899223197428490"},{"name":"batch_id","in":"query","required":false,"description":"Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)","schema":{"type":"string","description":"Only return labels that were created in a specific [batch](https://www.shipengine.com/docs/labels/bulk/)"}},{"name":"rate_id","in":"query","required":false,"description":"Rate ID","schema":{"type":"string","description":"Rate ID"}},{"name":"shipment_id","in":"query","required":false,"description":"Shipment ID","schema":{"type":"string","description":"Shipment ID"}},{"name":"warehouse_id","in":"query","required":false,"description":"Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)","schema":{"type":"string","description":"Only return labels that originate from a specific [warehouse](https://www.shipengine.com/docs/shipping/ship-from-a-warehouse/)"}},{"name":"created_at_start","in":"query","required":false,"description":"Only return labels that were created on or after a specific date/time","schema":{"type":"string","description":"Only return labels that were created on or after a specific date/time"},"example":"2019-03-12T19:24:13.657Z"},{"name":"created_at_end","in":"query","required":false,"description":"Only return labels that were created on or before a specific date/time","schema":{"type":"string","description":"Only return labels that were created on or before a specific date/time"},"example":"2019-03-12T19:24:13.657Z"},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"page_size","in":"query","required":false,"description":"The number of results to return per response.","schema":{"type":"integer","default":25,"description":"The number of results to return per response."},"example":50},{"name":"sort_dir","in":"query","required":false,"description":"Controls the sort order of the query.","schema":{"type":"string","enum":["asc","desc"],"description":"Controls the sort order of the query."}},{"name":"sort_by","in":"query","required":false,"description":"Controls which field the query is sorted by.","schema":{"type":"string","enum":["modified_at","created_at"],"default":"created_at","description":"Controls which field the query is sorted by."}}],"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/transport:shipengine/create-label":{"post":{"operationId":"transport_shipengine_create_label","summary":"Purchase Label","description":"POST /v1/labels","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/labels-get-by-external-shipment-id":{"get":{"operationId":"transport_shipengine_labels_get_by_external_shipment_id","summary":"Get Label By External Shipment ID","description":"GET /v1/labels/external_shipment_id/{external_shipment_id}","tags":["transport"],"parameters":[{"name":"external_shipment_id","in":"query","required":true,"schema":{"type":"string"},"example":"0bcb569d-1727-4ff9-ab49-b2fec0cee5ae"},{"name":"label_download_type","in":"query","required":false,"description":"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type |…","schema":{"type":"string","enum":["url","inline"],"description":"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type |…"},"example":"url"}],"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/transport:shipengine/labels-purchase-label-with-rate-id":{"post":{"operationId":"transport_shipengine_labels_purchase_label_with_rate_id","summary":"Purchase Label with Rate ID","description":"POST /v1/labels/rates/{rate_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["rate_id","body"],"properties":{"rate_id":{"type":"string","description":"Rate ID"},"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/transport:shipengine/labels-purchase-label-with-shipment-id":{"post":{"operationId":"transport_shipengine_labels_purchase_label_with_shipment_id","summary":"Purchase Label with Shipment ID","description":"POST /v1/labels/shipment/{shipment_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id","body"],"properties":{"shipment_id":{"type":"string","description":"Shipment ID"},"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/transport:shipengine/labels-get-by-id":{"get":{"operationId":"transport_shipengine_labels_get_by_id","summary":"Get Label By ID","description":"GET /v1/labels/{label_id}","tags":["transport"],"parameters":[{"name":"label_id","in":"query","required":true,"description":"Label ID","schema":{"type":"string","description":"Label ID"}},{"name":"label_download_type","in":"query","required":false,"description":"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type |…","schema":{"type":"string","enum":["url","inline"],"description":"There are two different ways to [download a label](https://www.shipengine.com/docs/labels/downloading/): |Label Download Type |…"},"example":"url"}],"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/transport:shipengine/labels-create-return-label":{"post":{"operationId":"transport_shipengine_labels_create_return_label","summary":"Create a return label","description":"POST /v1/labels/{label_id}/return","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label_id","body"],"properties":{"label_id":{"type":"string","description":"Label ID"},"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/transport:shipengine/labels-get-tracking-info":{"get":{"operationId":"transport_shipengine_labels_get_tracking_info","summary":"Get Label Tracking Information","description":"GET /v1/labels/{label_id}/track","tags":["transport"],"parameters":[{"name":"label_id","in":"query","required":true,"description":"Label ID","schema":{"type":"string","description":"Label ID"}}],"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/transport:shipengine/void-label":{"post":{"operationId":"transport_shipengine_void_label","summary":"Void a Label By ID","description":"PUT /v1/labels/{label_id}/void","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["label_id"],"properties":{"label_id":{"type":"string","description":"Label ID"}}}}}},"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/transport:shipengine/list-manifests":{"get":{"operationId":"transport_shipengine_list_manifests","summary":"List Manifests","description":"GET /v1/manifests","tags":["transport"],"parameters":[{"name":"warehouse_id","in":"query","required":false,"description":"Warehouse ID","schema":{"type":"string","description":"Warehouse ID"}},{"name":"ship_date_start","in":"query","required":false,"description":"ship date start range","schema":{"type":"string","description":"ship date start range"},"example":"2018-09-23T15:00:00.000Z"},{"name":"ship_date_end","in":"query","required":false,"description":"ship date end range","schema":{"type":"string","description":"ship date end range"},"example":"2018-09-23T15:00:00.000Z"},{"name":"created_at_start","in":"query","required":false,"description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"created_at_end","in":"query","required":false,"description":"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"carrier_id","in":"query","required":false,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"}},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"page_size","in":"query","required":false,"description":"The number of results to return per response.","schema":{"type":"integer","default":25,"description":"The number of results to return per response."},"example":50},{"name":"label_ids","in":"query","required":false,"description":"Array of label ids","schema":{"type":"array","description":"Array of label ids"}}],"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/transport:shipengine/create-manifest":{"post":{"operationId":"transport_shipengine_create_manifest","summary":"Create Manifest","description":"POST /v1/manifests","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/manifests-get-by-id":{"get":{"operationId":"transport_shipengine_manifests_get_by_id","summary":"Get Manifest By Id","description":"GET /v1/manifests/{manifest_id}","tags":["transport"],"parameters":[{"name":"manifest_id","in":"query","required":true,"description":"The Manifest Id","schema":{"type":"string","description":"The Manifest Id"}}],"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/transport:shipengine/manifests-get-request-by-id":{"get":{"operationId":"transport_shipengine_manifests_get_request_by_id","summary":"Get Manifest Request By Id","description":"GET /v1/manifests/requests/{manifest_request_id}","tags":["transport"],"parameters":[{"name":"manifest_request_id","in":"query","required":true,"description":"The Manifest Request Id","schema":{"type":"string","description":"The Manifest Request Id"}}],"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/transport:shipengine/packagetypes-list-custom-package-types":{"get":{"operationId":"transport_shipengine_packagetypes_list_custom_package_types","summary":"List Custom Package Types","description":"GET /v1/packages","tags":["transport"],"parameters":[],"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/transport:shipengine/packagetypes-create-custom-package-type":{"post":{"operationId":"transport_shipengine_packagetypes_create_custom_package_type","summary":"Create Custom Package Type","description":"POST /v1/packages","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/packagetypes-get-by-id":{"get":{"operationId":"transport_shipengine_packagetypes_get_by_id","summary":"Get Custom Package Type By ID","description":"GET /v1/packages/{package_id}","tags":["transport"],"parameters":[{"name":"package_id","in":"query","required":true,"description":"Package ID","schema":{"type":"string","description":"Package ID"}}],"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/transport:shipengine/packagetypes-update-custom-package-type-by-id":{"post":{"operationId":"transport_shipengine_packagetypes_update_custom_package_type_by_id","summary":"Update Custom Package Type By ID","description":"PUT /v1/packages/{package_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["package_id","body"],"properties":{"package_id":{"type":"string","description":"Package ID"},"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/transport:shipengine/packagetypes-delete-custom-package-by-id":{"post":{"operationId":"transport_shipengine_packagetypes_delete_custom_package_by_id","summary":"Delete A Custom Package By ID","description":"DELETE /v1/packages/{package_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["package_id"],"properties":{"package_id":{"type":"string","description":"Package ID"}}}}}},"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/transport:shipengine/packagepickups-list-scheduled-pickups":{"get":{"operationId":"transport_shipengine_packagepickups_list_scheduled_pickups","summary":"List Scheduled Pickups","description":"GET /v1/pickups","tags":["transport"],"parameters":[{"name":"carrier_id","in":"query","required":false,"description":"Carrier ID","schema":{"type":"string","description":"Carrier ID"}},{"name":"warehouse_id","in":"query","required":false,"description":"Warehouse ID","schema":{"type":"string","description":"Warehouse ID"}},{"name":"created_at_start","in":"query","required":false,"description":"Only return scheduled pickups that were created on or after a specific date/time","schema":{"type":"string","description":"Only return scheduled pickups that were created on or after a specific date/time"},"example":"2019-03-12T19:24:13.657Z"},{"name":"created_at_end","in":"query","required":false,"description":"Only return scheduled pickups that were created on or before a specific date/time","schema":{"type":"string","description":"Only return scheduled pickups that were created on or before a specific date/time"},"example":"2019-03-12T19:24:13.657Z"},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"page_size","in":"query","required":false,"description":"The number of results to return per response.","schema":{"type":"integer","default":25,"description":"The number of results to return per response."},"example":50}],"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/transport:shipengine/schedule-pickup":{"post":{"operationId":"transport_shipengine_schedule_pickup","summary":"Schedule a Pickup","description":"POST /v1/pickups","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/packagepickups-get-by-id":{"get":{"operationId":"transport_shipengine_packagepickups_get_by_id","summary":"Get Pickup By ID","description":"GET /v1/pickups/{pickup_id}","tags":["transport"],"parameters":[{"name":"pickup_id","in":"query","required":true,"description":"Pickup Resource ID","schema":{"type":"string","description":"Pickup Resource ID"}}],"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/transport:shipengine/packagepickups-remove-scheduled-pickup":{"post":{"operationId":"transport_shipengine_packagepickups_remove_scheduled_pickup","summary":"Delete a Scheduled Pickup","description":"DELETE /v1/pickups/{pickup_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["pickup_id"],"properties":{"pickup_id":{"type":"string","description":"Pickup Resource ID"}}}}}},"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/transport:shipengine/calculate-rates":{"post":{"operationId":"transport_shipengine_calculate_rates","summary":"Get Shipping Rates","description":"POST /v1/rates","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/rates-get-bulk-shipment-rates":{"post":{"operationId":"transport_shipengine_rates_get_bulk_shipment_rates","summary":"Get Bulk Rates","description":"POST /v1/rates/bulk","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/estimate-rates":{"post":{"operationId":"transport_shipengine_estimate_rates","summary":"Estimate Rates","description":"POST /v1/rates/estimate","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/rates-get-by-id":{"get":{"operationId":"transport_shipengine_rates_get_by_id","summary":"Get Rate By ID","description":"GET /v1/rates/{rate_id}","tags":["transport"],"parameters":[{"name":"rate_id","in":"query","required":true,"description":"Rate ID","schema":{"type":"string","description":"Rate ID"}}],"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/transport:shipengine/servicepoints-get-by-location":{"post":{"operationId":"transport_shipengine_servicepoints_get_by_location","summary":"List Service Points","description":"POST /v1/service_points/list","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/servicepoints-get-by-id":{"get":{"operationId":"transport_shipengine_servicepoints_get_by_id","summary":"Get Service Point By ID","description":"GET /v1/service_points/{carrier_code}/{country_code}/{service_point_id}","tags":["transport"],"parameters":[{"name":"carrier_code","in":"query","required":true,"description":"Carrier code","schema":{"type":"string","description":"Carrier code"},"example":"stamps_com"},{"name":"country_code","in":"query","required":true,"description":"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)","schema":{"type":"string","description":"A two-letter [ISO 3166-1 country code](https://en.wikipedia.org/wiki/ISO_3166-1)"},"example":"CA"},{"name":"service_point_id","in":"query","required":true,"schema":{"type":"string"},"example":"614940"}],"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/transport:shipengine/list-shipments":{"get":{"operationId":"transport_shipengine_list_shipments","summary":"List Shipments","description":"GET /v1/shipments","tags":["transport"],"parameters":[{"name":"shipment_status","in":"query","required":false,"description":"The possible shipment status values","schema":{"type":"string","enum":["pending","processing","label_purchased","cancelled"],"description":"The possible shipment status values"}},{"name":"batch_id","in":"query","required":false,"description":"Batch ID","schema":{"type":"string","description":"Batch ID"}},{"name":"tag","in":"query","required":false,"description":"Search for shipments based on the custom tag added to the shipment object","schema":{"type":"string","description":"Search for shipments based on the custom tag added to the shipment object"},"example":"Letters_to_santa"},{"name":"created_at_start","in":"query","required":false,"description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"created_at_end","in":"query","required":false,"description":"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was created, (ex. A shipment that was created before a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"modified_at_start","in":"query","required":false,"description":"Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was modified (ex. A shipment that was modified after a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"modified_at_end","in":"query","required":false,"description":"Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was modified (ex. A shipment that was modified before a certain time)"},"example":"2019-03-12T19:24:13.657Z"},{"name":"page","in":"query","required":false,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…","schema":{"type":"integer","default":1,"description":"Return a specific page of results. Defaults to the first page. If set to a number that's greater than the number of pages of results, an…"},"example":2},{"name":"page_size","in":"query","required":false,"description":"The number of results to return per response.","schema":{"type":"integer","default":25,"description":"The number of results to return per response."},"example":50},{"name":"sales_order_id","in":"query","required":false,"description":"Sales Order ID","schema":{"type":"string","description":"Sales Order ID"}},{"name":"sort_dir","in":"query","required":false,"description":"Controls the sort order of the query.","schema":{"type":"string","enum":["asc","desc"],"description":"Controls the sort order of the query."}},{"name":"sort_by","in":"query","required":false,"description":"The possible shipments sort by values","schema":{"type":"string","enum":["modified_at","created_at"],"description":"The possible shipments sort by values"},"example":"modified_at"}],"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/transport:shipengine/create-shipments":{"post":{"operationId":"transport_shipengine_create_shipments","summary":"Create Shipments","description":"POST /v1/shipments","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/shipments-get-by-external-id":{"get":{"operationId":"transport_shipengine_shipments_get_by_external_id","summary":"Get Shipment By External ID","description":"GET /v1/shipments/external_shipment_id/{external_shipment_id}","tags":["transport"],"parameters":[{"name":"external_shipment_id","in":"query","required":true,"schema":{"type":"string"},"example":"0bcb569d-1727-4ff9-ab49-b2fec0cee5ae"}],"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/transport:shipengine/parse-shipment":{"post":{"operationId":"transport_shipengine_parse_shipment","summary":"Parse shipping info","description":"PUT /v1/shipments/recognize","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/shipments-get-by-id":{"get":{"operationId":"transport_shipengine_shipments_get_by_id","summary":"Get Shipment By ID","description":"GET /v1/shipments/{shipment_id}","tags":["transport"],"parameters":[{"name":"shipment_id","in":"query","required":true,"description":"Shipment ID","schema":{"type":"string","description":"Shipment ID"}}],"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/transport:shipengine/update-shipment":{"post":{"operationId":"transport_shipengine_update_shipment","summary":"Update Shipment By ID","description":"PUT /v1/shipments/{shipment_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id","body"],"properties":{"shipment_id":{"type":"string","description":"Shipment ID"},"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/transport:shipengine/cancel-shipments":{"post":{"operationId":"transport_shipengine_cancel_shipments","summary":"Cancel a Shipment","description":"PUT /v1/shipments/{shipment_id}/cancel","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id"],"properties":{"shipment_id":{"type":"string","description":"Shipment ID"}}}}}},"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/transport:shipengine/shipments-get-rates-for-shipment":{"get":{"operationId":"transport_shipengine_shipments_get_rates_for_shipment","summary":"Get Shipment Rates","description":"GET /v1/shipments/{shipment_id}/rates","tags":["transport"],"parameters":[{"name":"shipment_id","in":"query","required":true,"description":"Shipment ID","schema":{"type":"string","description":"Shipment ID"}},{"name":"created_at_start","in":"query","required":false,"description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)","schema":{"type":"string","description":"Used to create a filter for when a resource was created (ex. A shipment that was created after a certain time)"},"example":"2019-03-12T19:24:13.657Z"}],"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/transport:shipengine/shipments-update-tags":{"post":{"operationId":"transport_shipengine_shipments_update_tags","summary":"Update Shipments Tags","description":"PUT /v1/shipments/tags","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/shipments-get-tags-by-id":{"get":{"operationId":"transport_shipengine_shipments_get_tags_by_id","summary":"Get Shipment Tags","description":"GET /v1/shipments/{shipment_id}/tags","tags":["transport"],"parameters":[{"name":"shipment_id","in":"query","required":true,"description":"Shipment ID","schema":{"type":"string","description":"Shipment ID"}}],"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/transport:shipengine/tag-shipment":{"post":{"operationId":"transport_shipengine_tag_shipment","summary":"Add Tag to Shipment","description":"POST /v1/shipments/{shipment_id}/tags/{tag_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id","tag_name"],"properties":{"shipment_id":{"type":"string","description":"Shipment ID"},"tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"}}}}}},"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/transport:shipengine/untag-shipment":{"post":{"operationId":"transport_shipengine_untag_shipment","summary":"Remove Tag from Shipment","description":"DELETE /v1/shipments/{shipment_id}/tags/{tag_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["shipment_id","tag_name"],"properties":{"shipment_id":{"type":"string","description":"Shipment ID"},"tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"}}}}}},"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/transport:shipengine/list-tags":{"get":{"operationId":"transport_shipengine_list_tags","summary":"Get Tags","description":"GET /v1/tags","tags":["transport"],"parameters":[],"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/transport:shipengine/create-tag":{"post":{"operationId":"transport_shipengine_create_tag","summary":"Create a New Tag","description":"POST /v1/tags/{tag_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"}}}}}},"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/transport:shipengine/delete-tag":{"post":{"operationId":"transport_shipengine_delete_tag","summary":"Delete Tag","description":"DELETE /v1/tags/{tag_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tag_name"],"properties":{"tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"}}}}}},"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/transport:shipengine/rename-tag":{"post":{"operationId":"transport_shipengine_rename_tag","summary":"Update Tag Name","description":"PUT /v1/tags/{tag_name}/{new_tag_name}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["tag_name","new_tag_name"],"properties":{"tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"},"new_tag_name":{"type":"string","description":"Tags are arbitrary strings that you can use to categorize shipments. For example, you may want to use tags to distinguish between domestic…"}}}}}},"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/transport:shipengine/tokens-generate-ephemeral-token":{"post":{"operationId":"transport_shipengine_tokens_generate_ephemeral_token","summary":"Get Ephemeral Token","description":"POST /v1/tokens/ephemeral","tags":["transport"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"redirect":{"type":"string","enum":["shipengine-dashboard"],"description":"Include a redirect url to the application formatted with the ephemeral token."}}}}}},"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/transport:shipengine/tracking-info-retrieval":{"get":{"operationId":"transport_shipengine_tracking_info_retrieval","summary":"Get Tracking Information","description":"GET /v1/tracking","tags":["transport"],"parameters":[{"name":"carrier_code","in":"query","required":false,"description":"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc.","schema":{"type":"string","description":"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc."},"example":"stamps_com"},{"name":"tracking_number","in":"query","required":false,"description":"The tracking number associated with a shipment","schema":{"type":"string","description":"The tracking number associated with a shipment"},"example":"9405511899223197428490"}],"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/transport:shipengine/start-tracking":{"post":{"operationId":"transport_shipengine_start_tracking","summary":"Start Tracking a Package","description":"POST /v1/tracking/start","tags":["transport"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"carrier_code":{"type":"string","description":"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc."},"tracking_number":{"type":"string","description":"The tracking number associated with a shipment"}}}}}},"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/transport:shipengine/stop-tracking":{"post":{"operationId":"transport_shipengine_stop_tracking","summary":"Stop Tracking a Package","description":"POST /v1/tracking/stop","tags":["transport"],"parameters":[],"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"carrier_code":{"type":"string","description":"A [shipping carrier](https://www.shipengine.com/docs/carriers/setup/), such as `fedex`, `dhl_express`, `stamps_com`, etc."},"tracking_number":{"type":"string","description":"The tracking number associated with a shipment"}}}}}},"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/transport:shipengine/list-warehouses":{"get":{"operationId":"transport_shipengine_list_warehouses","summary":"List Warehouses","description":"GET /v1/warehouses","tags":["transport"],"parameters":[],"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/transport:shipengine/create-warehouse":{"post":{"operationId":"transport_shipengine_create_warehouse","summary":"Create Warehouse","description":"POST /v1/warehouses","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["body"],"properties":{"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/transport:shipengine/warehouses-get-by-id":{"get":{"operationId":"transport_shipengine_warehouses_get_by_id","summary":"Get Warehouse By Id","description":"GET /v1/warehouses/{warehouse_id}","tags":["transport"],"parameters":[{"name":"warehouse_id","in":"query","required":true,"description":"Warehouse ID","schema":{"type":"string","description":"Warehouse ID"}}],"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/transport:shipengine/update-warehouse":{"post":{"operationId":"transport_shipengine_update_warehouse","summary":"Update Warehouse By Id","description":"PUT /v1/warehouses/{warehouse_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["warehouse_id","body"],"properties":{"warehouse_id":{"type":"string","description":"Warehouse ID"},"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/transport:shipengine/delete-warehouse":{"post":{"operationId":"transport_shipengine_delete_warehouse","summary":"Delete Warehouse By ID","description":"DELETE /v1/warehouses/{warehouse_id}","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["warehouse_id"],"properties":{"warehouse_id":{"type":"string","description":"Warehouse ID"}}}}}},"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/transport:shipengine/warehouses-update-settings":{"post":{"operationId":"transport_shipengine_warehouses_update_settings","summary":"Update Warehouse Settings","description":"PUT /v1/warehouses/{warehouse_id}/settings","tags":["transport"],"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["warehouse_id","body"],"properties":{"warehouse_id":{"type":"string","description":"Warehouse ID"},"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"}}}}}}}