AfterShip

with aftership modules in {{product name}} , you can create and monitor your trackings, manage notifications, and make api calls to get started with aftership, create an account at aftership com https //www aftership com/ connecting aftership to {{product name}} to make a connection you need an api key log in to your aftership account click settings , then click api keys a default api is already created you use this one or create a new one copy the api key to your clipboard go to your {{product name}} {{scenario singular lowercase}} and choose the aftership module you want to use under connection , click add give your new connection a name paste the api key in the field below click save you have successfully created the connection trackings search trackings searches for trackings or lists them all connection aftership /#connecting aftership to keyword enter any keywords to search the content of the tracking record fields tracking number , title , order id , customer name , custom fields , order id , emails , smses slug select couriers delivery time enter the total delivery time in days note value as 0 for pending shipments or delivered shipment with only one checkpoint origin select the origin country destination select the destination country tag select the current status of tracking pending info received in transit out for delivery attempt fail delivered available for pickup exception expired created at minimum enter the start date and time of trackings created created at maximum enter the end date and time of trackings created updated at minimum enter the start date and time of trackings updated updated at maximum enter the end date and time of trackings updated fields select the fields to include in the results language select the language last updated at enter when the tracking was last updated return to sender select whether the shipment gets returned to the sender courier destination country iso3 select the destination country of trackings returned by courier limit enter the maximum number of trackings make returns during one {{scenario singular lowercase}} execution cycle get a tracking retrieves an existing tracking connection aftership /#connecting aftership to tracking number enter or select the tracking number of the tracking you want to retrieve fields select the fields to include in the results language select the language tracking account number enter the account number of the shipper for a specific courier tracking origin country enter the origin country of the shipment for a specific courier tracking destination country enter the destination country of the shipment for a specific courier tracking key enter the key of the shipment for a specific courier tracking postal code enter the postal code of receiver's address tracking ship date enter the shipping date tracking state enter the located state of the shipment for a specific courier create a tracking creates a new tracking connection aftership /#connecting aftership to tracking number enter the tracking number of the shipment slug select couriers title enter the title of the tracking order id enter the order id order id path enter the order id path custom fields add any custom fields to the tracking language select the language order promised delivery date enter the promised delivery date of the order delivery type select the shipment delivery type pickup at store pickup at courier door to door pickup location enter the shipment pickup location for receiver pickup note enter the shipment pickup note for receiver tracking account number enter the account number of the shipper for a specific courier tracking origin country enter the origin country of the shipment for a specific courier tracking destination country enter the destination country of the shipment for a specific courier tracking key enter the key of the shipment for a specific courier tracking postal code enter the postal code of receiver's address tracking ship date enter the shipping date tracking state enter the located state of the shipment for a specific courier ios add apple ios device ids to receive the push notifications android add google cloud message registration ids to receive the push notifications emails add email address(es) to receive email notifications smses add phone number(s) to receive sms notifications customer name enter the customer name of the tracking origin country iso3 select the origin country of the shipment destination country iso3 select the destination country of the shipment note enter any additional notes update a tracking updates an existing tracking connection aftership /#connecting aftership to tracking number enter the tracking number of the shipment smses add phone number(s) to receive sms notifications emails add email address(es) to receive email notifications title enter the title of the tracking customer name enter the customer name of the tracking order id enter the order id order id path enter the order id path custom fields add any custom fields to the tracking note enter any additional notes language select the language order promised delivery date enter the promised delivery date of the order delivery type select the shipment delivery type pickup at store pickup at courier door to door pickup location enter the shipment pickup location for receiver pickup note enter the shipment pickup note for receiver delete a tracking deletes an existing tracking connection aftership /#connecting aftership to tracking number enter or select the id number of the tracking you want to delete notifications get a notification retrieves an existing notification connection aftership /#connecting aftership to tracking number enter or select the id number of the tracking tracking account number enter the account number of the shipper for a specific courier tracking origin country enter the origin country of the shipment for a specific courier tracking destination country enter the destination country of the shipment for a specific courier tracking key enter the key of the shipment for a specific courier tracking postal code enter the the postal code of receiver's address tracking ship date enter the shipping date tracking state enter the located state of the shipment for a specific courier add a notification adds notification receivers to a tracking number connection aftership /#connecting aftership to tracking number enter or select the id number of the tracking emails add email address(es) to receive email notifications smses add phone number(s) to receive sms notifications tracking account number enter the account number of the shipper for a specific courier tracking origin country enter the origin country of the shipment for a specific courier tracking destination country enter the destination country of the shipment for a specific courier tracking key enter the key of the shipment for a specific courier tracking postal code enter the the postal code of receiver's address tracking ship date enter the shipping date tracking state enter the located state of the shipment for a specific courier remove a notification removes an existing notification connection aftership /#connecting aftership to tracking number enter or select the id number of the tracking emails add email address(es) to receive email notifications smses add phone number(s) to receive sms notifications tracking account number enter the account number of the shipper for a specific courier tracking origin country enter the origin country of the shipment for a specific courier tracking destination country enter the destination country of the shipment for a specific courier tracking key enter the key of the shipment for a specific courier tracking postal code enter the the postal code of receiver's address tracking ship date enter the shipping date tracking state enter the located state of the shipment for a specific courier other make an api call performs an arbitrary authorized api call connection aftership /#connecting aftership to url enter a path relative to https //api aftership com/v4 for example /v4/trackings for the list of available endpoints, refer to the aftership api documentation method select the http method you want to use get to retrieve information for an entry post to create a new entry put to update/replace an existing entry patch to make a partial entry update delete to delete an entry headers enter the desired request headers you don't have to add authorization headers; we already did that for you query string enter the request query string body enter the body content for your api call example of use list trackings the following api call returns a list of all the shipment trackings in your aftership account url /v4/trackings method get matches of the search can be found in the module's output under bundle > body > data > trackings our example returned 2 shipment trackings