Versions Compared

Old Version 46

changes.mady.by.user Dean Mitchell

Saved on

compared with

New Version Current

changes.mady.by.user Dean Mitchell

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleFetching Services Available at an Address

Once a geo-coordinate has been obtained the services available to the address can be retrieved from the services endpoint /v1/services.

Expand
titleFetching Local Service Locations

The geo-coordinate can also be used to retrieve the service locations in proximity using /v1/service-locations.

This endpoint allows filtering by the type of Service Location and specifying a radius from the geo-coordinate. If no radius is provided it will return all service locations.

Expand
titleFetching Rates for a Consignment

With a valid geo-coordinate for the address the rate for a consignment can be determined using /v1/carriers/{carrierName}/customers/{customerId}/rates.

Expand
titleCreating a Consignment

A consignment can be created with a POST to /v1/carriers/{carrierName}/customers/{customerId}/consignments.

The response will include the identifiers for each item, barcode strings for each consignment item, and the calculated cost.

This request can also be used to create a label in which case the response will include a link to retrieve the barcode.

Expand
titleFetching Consignments

A list of consignments can be fetched using a GET from /v1/carriers/{carrierName}/customers/{customerId}/consignments

A single item can be retrieved from /v1/carriers/{carrierName}/customers/{customerId}/consignments/{consignmentId}

Expand
titleCanceling a Consignment

A request to cancel a consignment can be made with a POST to /v1/carriers/{carrierName}/customers/{customerId}/consignments/{consignmentId}/CancellationRequests

At this time, this will record a request to cancel which will be manually handled.

Expand
titlePlacing a Pickup Request

A consignment can be created with a POST to /v1/carriers/{carrierName}/customers/{customerId}/pickup-location-pickup-requests

This post will identify the pickup location using the issued PIN identifier.

Expand
titleReprinting a Label

If a label needs to be reprinted for an existing consignment place a GET request to /v1/carriers/{carrierName}/customers/{customerId}/consignments/{consignmentId}/labels