Actions (91)
Shipments · 14
- Add tag to shipmentPOST /v2/shipments/{shipment_id}/tags/{tag_name}
Add a tag to a shipment.
documented - Add tag to shipmentPOST /v2/shipments/{shipment_id}/tags/{tag_name}
Add a tag to a shipment.
documented - Cancel shipmentGET /v2/shipments/{shipment_id}/cancel
Cancel a shipment.
documented - Cancel shipmentPUT /v2/shipments/{shipment_id}/cancel
Cancel a shipment.
documented - Create shipmentPOST /shipments
Create a new shipment.
documented - Create shipmentPOST /v2/shipments
Create a new shipment.
documented - Get shipmentGET /shipments/{shipment_id}
Retrieve a shipment.
documented - Get shipmentGET /v2/shipments/{shipment_id}
Get a shipment by ID.
documented - Get shipment by external IDGET /v2/shipments/external_shipment_id/{external_shipment_id}
Fetch a shipment by external ID.
documented - Get shipment ratesGET /v2/shipments/{shipment_id}/rates
Retrieve shipping rates for a shipment.
documented - Get shipment ratesGET /v2/shipments/{shipment_id}/rates
Retrieve shipping rates for a shipment.
documented - List shipmentsGET /v2/shipments
List shipments.
documented - Remove shipment tagDELETE /v2/shipments/{shipment_id}/tags/{tag_name}
Remove a tag from a shipment.
documented - Remove shipment tagDELETE /v2/shipments/{shipment_id}/tags/{tag_name}
Remove a tag from a shipment.
documented
Inventory · 12
- Create inventory locationPOST /v2/inventory_locations
Create a new inventory location.
documented - Create inventory warehousePOST /v2/inventory_warehouses
Create a new inventory warehouse.
documented - Delete inventory locationDELETE /v2/inventory_locations/{inventory_location_id}
Delete an inventory location.
documented - Delete inventory warehouseDELETE /v2/inventory_warehouses/{inventory_warehouse_id}
Delete an inventory warehouse.
documented - Get inventory locationGET /v2/inventory_locations/{inventory_location_id}
Get details for a specific inventory location.
documented - Get inventory warehouseGET /v2/inventory_warehouses/{inventory_warehouse_id}
Get details for a specific inventory warehouse.
documented - List SKU inventory levelsGET /v2/inventory
List current stock levels for SKUs (optionally filtered by SKU/inventory_warehouse_id/location).
documented - List inventory locationsGET /v2/inventory_locations
List all inventory locations.
documented - List inventory warehousesGET /v2/inventory_warehouses
List all inventory warehouses.
documented - Update inventoryPOST /v2/inventory
Update stock levels and related properties for inventory SKUs.
documented - Update inventory locationPUT /v2/inventory_locations/{inventory_location_id}
Update an inventory location.
documented - Update inventory warehousePUT /v2/inventory_warehouses/{inventory_warehouse_id}
Update an inventory warehouse.
documented
Batches · 8
- Add to batchPOST /v2/batches/{batch_id}/add
Add shipments/items to an existing batch.
documented - Create batchPOST /v2/batches
Create a new label batch.
documented - Delete batchDELETE /v2/batches/{batch_id}
Remove a batch by its internal batch_id.
documented - Get batch by external IDGET /v2/batches/external_batch_id/{external_batch_id}
Retrieve a batch by its external_batch_id.
documented - Get batch detailsGET /v2/batches/{batch_id}
Fetch details for a specific batch.
documented - Get batch errorsGET /v2/batches/{batch_id}/errors
List errors for a batch.
documented - List batchesGET /v2/batches
Return a list of label batches.
documented - Update batchPUT /v2/batches/{batch_id}
Modify properties of an existing batch.
documented
Labels · 8
- Create labelPOST /v2/labels
Create a shipping label.
documented - Create shipment labelPOST /v2/labels/shipment/{shipment_id}
Create a label for a specific shipment.
documented - Get labelGET /v2/labels/{label_id}
Get details for a specific label.
documented - Get label ratesPOST /v2/labels/rates/{rate_id}
Obtain rates for a given label rate_id.
documented - List labelsGET /v2/labels
List shipping labels.
documented - Return labelPOST /v2/labels/{label_id}/return
Create a return label for a label.
documented - Track labelGET /v2/labels/{label_id}/track
Track a label.
documented - Void labelPUT /v2/labels/{label_id}/void
Void a label.
documented
Carriers · 6
- Get carrier detailsGET /v2/carriers/{carrier_id}
Fetch details for a specific carrier.
documented - Get carrier optionsGET /v2/carriers/{carrier_id}/options
Retrieve available options for a carrier.
documented - Get carrier packagesGET /v2/carriers/{carrier_id}/packages
List package types offered by a carrier.
documented - Get carrier servicesGET /v2/carriers/{carrier_id}/services
List service codes for a carrier.
documented - List carrier servicesGET /carriers/listservices?carrierCode={code}
List services for a given carrier.
documented - List carriersGET /v2/carriers
Retrieve carriers connected to the account.
documented
Webhooks · 6
- Create webhookPOST /v2/environment/webhooks
Create a webhook.
documented - Delete webhookDELETE /v2/environment/webhooks/{webhook_id}
Delete a webhook.
documented - Get webhookGET /v2/environment/webhooks/{webhook_id}
Get a webhook by ID.
documented - List webhooksGET /v2/environment/webhooks
List webhooks for the environment.
documented - List webhooksGET /v2/environment/webhooks
List webhooks for the environment.
documented - Update webhookPUT /v2/environment/webhooks/{webhook_id}
Update a webhook.
documented
Packages · 5
- Create packagePOST /v2/packages
Create a package type.
documented - Delete packageDELETE /v2/packages/{package_id}
Delete a package.
documented - Get packageGET /v2/packages/{package_id}
Get a package by ID.
documented - List packagesGET /v2/packages
List customs-friendly package types.
documented - Update packagePUT /v2/packages/{package_id}
Update a package.
documented