Available AfterShip APIs

Naga Sri Hari Gonaboyina

Updated November 19, 2024 20:14

When you configure an export, import, or other type of flow step using the prebuilt AfterShip connector, you can select any of the API operations listed below*, organized by API type.

Note

If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the AfterShip API documentation. *You can also create a composite endpoint for this application in HTTP mode.

API type	Resource	API endpoint	Export	Import
Address	Geocodes	Get geocodes	X
Commerce	Orders	Get orders	X
		Create an order		X
		Get an order	X
		Update an order		X
	Product	Get a product	X
		Create a product		X
		Update a product		X
	Stores	List stores	X
		Create a store		X
		Update a store		X
		Get a stores	X
Members	Memberships	Get memberships	X
		Create membership		X
		Get membership by ID	X
		Update membership by ID		X
		Delete membership by ID		X
	Roles	Get roles	X
Parser	Email parses	Parse an email		X
Parser	Email parses	Parse an email v2		X
Protection	Coverages	Query coverages	X
		Create a coverage		X
		Get a coverage	X
		Update a coverage tracking info		X
		Void a coverage		X
		Calculate the premium		X
	Claims	Query claims	X
	Claims	Get a claim	X
Returns	Returns	Update return status		X
		Update return status rejection		X
		Update return status approval		X
		Update return status by RMA		X
		Update return status by RMA rejection		X
		Update return status by RMA approval		X
		Update return items: Update merchant tags		X
		Update return items: Update merchant images		X
		Batch mark items as received		X
		Update return items by RMA: Update merchant images		X
		Update return items by RMA: Update merchant tags		X
	Merchant tags	Get merchant tags	X
Shipping	Labels	Get labels	X
		Create a label		X
		Get a label	X
	Couriers	Get all couriers	X
	Cancel labels	Get the canceled labels	X
		Cancel a label		X
		Get a canceled label	X
	Address validations (Beta)	Create an address validation		X
	Locations	Get locations	X
	Manifests	Get manifests	X
		Create a manifest		X
		Get a manifest	X
	Rates	Get rates	X
		Calculate rates		X
		Get a rate	X
	Pickups	Get pickups	X
		Create a pickup		X
		Get a pickup	X
	Cancel pickups	Get the canceled pickups	X
		Cancel a pickup		X
		Get a canceled pickup	X
	Shipper accounts	Get shipper accounts	X
		Create a shipper account		X
		Get a shipper account	X
		Delete a shipper account		X
		Update a shipper account's information		X
		Update a shipper account's credentials		X
		Update a shipper account's settings		X
Tracking	Trackings	Get trackings	X
		Create a tracking		X
		Get a tracking by ID	X
		Update a tracking by ID		X
		Delete a tracking by ID		X
		Retrack an expired tracking by ID		X
		Mark tracking as completed by ID		X
		Get a tracking (legacy)	X
		Update a tracking (legacy)		X
		Delete a tracking (legacy)		X
		Retrack an expired tracking (legacy)		X
		Mark tracking as completed (legacy)		X
	Couriers	Get user-activated couriers	X
		Detect courier		X
		Get all couriers	X
	Last checkpoints	Get last checkpoint by tracking ID	X
	Last checkpoints	Get last checkpoint (legacy)	X
	Notifications	Get tracking notification by tracking ID	X
		Add a notification by tracking ID		X
		Remove a notification by tracking ID		X
		Get tracking notification (legacy)	X
		Add a notification (legacy)		X
		Remove a notification (legacy)		X
	Estimated delivery date	Batch predict the estimated delivery date		X