|
| GET | /v2/account/settings | List account settings |
| GET | /v2/account/settings/images | List account images |
| POST | /v2/account/settings/images | Create an account image |
| GET | /v2/account/settings/images/{label_image_id} | Get account image by ID |
| PUT | /v2/account/settings/images/{label_image_id} | Update account image by ID |
| DELETE | /v2/account/settings/images/{label_image_id} | Delete account image by ID |
|
| GET | /v2/batches | List batches |
| POST | /v2/batches | Create a batch |
| GET | /v2/batches/external_batch_id/{external_batch_id} | Get batch by external id |
| DELETE | /v2/batches/{batch_id} | Delete batch by id |
| GET | /v2/batches/{batch_id} | Get batch by id |
| PUT | /v2/batches/{batch_id} | Update batch status to 'archived' by id |
| POST | /v2/batches/{batch_id}/add | Add to a batch |
| GET | /v2/batches/{batch_id}/errors | Get batch errors |
| POST | /v2/batches/{batch_id}/process/labels | Process batch id labels |
| POST | /v2/batches/{batch_id}/remove | Remove from batch |
|
| GET | /v2/carriers | List carriers |
| GET | /v2/carriers/{carrier_id} | Get carrier by id |
| GET | /v2/carriers/{carrier_id}/options | Get carrier options |
| GET | /v2/carriers/{carrier_id}/packages | List carrier package types |
| GET | /v2/carriers/{carrier_id}/services | List carrier services |
| DELETE | /v2/carriers/{carrier_id} | Disconnect carrier by id |
| PUT | /v2/carriers/{carrier_id}/add_funds | Add funds to carrier |
|
| POST | /v2/checkout_rates | Create a checkout rates configuration |
| GET | /v2/checkout_rates | List checkout rates configurations |
| GET | /v2/checkout_rates/{config_id} | Get a checkout rates configuration |
| POST | /v2/checkout_rates/{config_id}/options | Add a delivery option |
| GET | /v2/checkout_rates/{config_id}/options/{option_id} | Get a delivery option |
| PUT | /v2/checkout_rates/{config_id}/options/{option_id} | Update a delivery option |
| DELETE | /v2/checkout_rates/{config_id}/options/{option_id} | Delete a delivery option |
| POST | /v2/checkout_rates/{config_id}/quotes | Calculate checkout rates |
| GET | /v2/checkout_rates/quotes/{quote_id} | Get a checkout rate quote |
|
| POST | /v2/labels/{label_id}/documents | Register a document for a label |
| GET | /v2/labels/{label_id}/documents | List documents for a label |
| DELETE | /v2/labels/{label_id}/documents/{document_id} | Delete a label document |
| POST | /v2/labels/{label_id}/documents/send | Send label documents |
| GET | /v2/documents/{document_id}/download | Download a document |
| POST | /v2/shipments/{shipment_id}/documents | Register a document for a shipment |
| GET | /v2/shipments/{shipment_id}/documents | List documents for a shipment |
| DELETE | /v2/shipments/{shipment_id}/documents/{document_id} | Delete a shipment document |
| GET | /v2/shipments/{shipment_id}/labels | List shipments and their document statuses |
|
| GET | /v2/downloads/{dir}/{subdir}/{filename} | Download file |
|
| GET | /v2/freight/provider_accounts | List freight provider accounts |
| POST | /v2/freight/quotes | Get freight quotes |
| POST | /v2/freight/shipments | Book a freight shipment |
| GET | /v2/freight/shipments | List freight shipments |
| GET | /v2/freight/shipments/{freight_shipment_id} | Get freight shipment by ID |
| DELETE | /v2/freight/shipments/{freight_shipment_id} | Cancel a freight shipment |
| GET | /v2/freight/shipments/{freight_shipment_id}/documents | List freight shipment documents |
| GET | /v2/freight/shipments/{freight_shipment_id}/tracking | Get freight shipment tracking |
| GET | /v2/freight/tracking | Get freight tracking by number |
|
| GET | /v2/fulfillments | List fulfillments |
| POST | /v2/fulfillments | Create fulfillments |
|
| GET | /v2/inventory | List SKU inventory levels |
| POST | /v2/inventory | Update SKU stock levels and related properties |
| GET | /v2/inventory_warehouses | List all inventory warehouses |
| POST | /v2/inventory_warehouses | Create a new inventory warehouse |
| GET | /v2/inventory_warehouses/{inventory_warehouse_id} | Get a specific inventory warehouse and related properties using its warehouse ID |
| PUT | /v2/inventory_warehouses/{inventory_warehouse_id} | Update an inventory warehouse name |
| DELETE | /v2/inventory_warehouses/{inventory_warehouse_id} | Delete an inventory warehouse |
| GET | /v2/inventory_locations | List all inventory locations |
| POST | /v2/inventory_locations | Create a new inventory location |
| GET | /v2/inventory_locations/{inventory_location_id} | Get inventory location by ID |
| PUT | /v2/inventory_locations/{inventory_location_id} | Update an inventory location |
| DELETE | /v2/inventory_locations/{inventory_location_id} | Delete an inventory location |
|
| GET | /v2/labels | List labels |
| POST | /v2/labels | Purchase label |
| POST | /v2/labels/rates/{rate_id} | Purchase label with rate id |
| POST | /v2/labels/shipment/{shipment_id} | Purchase label with shipment id |
| POST | /v2/labels/rate_shopper_id/{rate_shopper_id} | Purchase label with rate shopper |
| POST | /v2/labels/shipping_rules/{shipping_rule_id} | Purchase label with shipping rule |
| GET | /v2/labels/{label_id} | Get label by id |
| GET | /v2/labels/external_shipment_id/{external_shipment_id} | Get label by external shipment ID |
| POST | /v2/labels/{label_id}/return | Create a return label |
| GET | /v2/labels/{label_id}/track | Get label tracking information |
| PUT | /v2/labels/{label_id}/void | Void a label by id |
| POST | /v2/labels/{label_id}/cancel_refund | Cancel a label refund request |
| POST | /v2/documents/combined_labels | Created combined label document |
|
| POST | /v2/mailing/netstamps | Create netstamps |
| POST | /v2/mailing/mail_labels | Create mailing labels |
| POST | /v2/mailing/envelopes | Create envelope |
|
| GET | /v2/manifests | List manifests |
| POST | /v2/manifests | Create manifest |
| GET | /v2/manifests/{manifest_id} | Get manifest by id |
| GET | /v2/manifests/requests/{manifest_request_id} | Get manifest request by ID |
|
| GET | /v2/pickups | List scheduled pickups |
| POST | /v2/pickups | Schedule a pickup |
| GET | /v2/pickups/{pickup_id} | Get pickup by id |
| DELETE | /v2/pickups/{pickup_id} | Delete a scheduled pickup |
|
| GET | /v2/packages | List custom package types |
| POST | /v2/packages | Create custom package type |
| GET | /v2/packages/{package_id} | Get custom package type by id |
| PUT | /v2/packages/{package_id} | Update custom package type by id |
| DELETE | /v2/packages/{package_id} | Delete a custom package by id |
|
| GET | /v2/purchase_orders | List purchase orders |
| POST | /v2/purchase_orders | Create a new purchase order |
| GET | /v2/purchase_orders/{purchase_order_id} | Get purchase order details |
| PUT | /v2/purchase_orders/{purchase_order_id} | Update a purchase order |
| POST | /v2/purchase_orders/{purchase_order_id}/shipping_details | Update purchase order shipping details |
| POST | /v2/purchase_orders/{purchase_order_id}/status | Update purchase order status |
| POST | /v2/purchase_orders/{purchase_order_id}/receives | Receive purchase order products |
| GET | /v2/purchase_orders/{purchase_order_id}/documents/order_summary | Get purchase order summary PDF |
| GET | /v2/purchase_orders/{purchase_order_id}/documents/received_summary | Get purchase order received summary PDF |
|
| GET | /v2/rate_shoppers | List rate shoppers |
| GET | /v2/rate_shoppers/{rate_shopper_id} | Get rate shopper by ID |
|
| POST | /v2/rates | Get shipping rates |
| POST | /v2/rates/estimate | Estimate rates |
| GET | /v2/rates/{rate_id} | Get rate by id |
| POST | /v2/rates/bulk | Get bulk rates |
|
| GET | /v2/shipments | List shipments |
| POST | /v2/shipments | Create shipments |
| POST | /v2/shipments/user | Assign user to shipments |
| GET | /v2/shipments/external_shipment_id/{external_shipment_id} | Get shipment by external id |
| GET | /v2/shipments/{shipment_id} | Get shipment by id |
| PUT | /v2/shipments/{shipment_id} | Update a shipment |
| PUT | /v2/shipments/{shipment_id}/cancel | Cancel a shipment |
| GET | /v2/shipments/{shipment_id}/rates | Get shipment rates |
| GET | /v2/shipments/{shipment_id}/tags | Get shipment tags |
| POST | /v2/shipments/{shipment_id}/tags/{tag_name} | Add tag to shipment |
| DELETE | /v2/shipments/{shipment_id}/tags/{tag_name} | Remove tag from shipment |
| POST | /v2/shipments/{shipment_id}/internal_notes | Update internal notes for a shipment |
|
| GET | /v2/suppliers | List suppliers |
| POST | /v2/suppliers | Create a new supplier |
| GET | /v2/suppliers/{supplier_id} | Get supplier details |
| PUT | /v2/suppliers/{supplier_id} | Update a supplier |
|
| GET | /v2/tags | Get tags |
| POST | /v2/tags | Create a new tag |
| POST | /v2/tags/{tag_name} | Create a new tag |
| DELETE | /v2/tags/{tag_name} | Delete tag |
| PUT | /v2/tags/{tag_name}/{new_tag_name} | Update tag name |
|
| POST | /v2/tokens/ephemeral | Get ephemeral token |
|
| GET | /v2/totes | List totes |
| POST | /v2/totes | Create totes in batch |
| GET | /v2/totes/quantities | Get tote quantities |
| GET | /v2/totes/{tote_id} | Get tote by ID |
| PUT | /v2/totes/{tote_id} | Update tote |
| DELETE | /v2/totes/{tote_id} | Delete tote |
|
| POST | /v2/tracking/stop | Stop tracking a package |
|
| GET | /v2/users | List users |
|
| GET | /v2/warehouses | List warehouses |
| GET | /v2/warehouses/{warehouse_id} | Get warehouse by id |
| POST | /v2/warehouses | Create warehouse |
| PUT | /v2/warehouses/{warehouse_id} | Update warehouse by ID |
| DELETE | /v2/warehouses/{warehouse_id} | Delete warehouse by ID |
| PUT | /v2/warehouses/{warehouse_id}/settings | Update warehouse settings |
|
| GET | /v2/environment/webhooks | List webhooks |
| POST | /v2/environment/webhooks | Create a webhook |
| GET | /v2/environment/webhooks/{webhook_id} | Get webhook by id |
| PUT | /v2/environment/webhooks/{webhook_id} | Update a webhook |
| DELETE | /v2/environment/webhooks/{webhook_id} | Delete webhook by id |