GET v3/shipments/:id

GET 
/v3/shipments/:id

Retrieve one shipment by its id.

This endpoint returns a single shipment resource. The request requires a path parameter which is the id of the shipment to fetch. It returns only a shipment if it can be be found and the associated id belongs to a shipment that was generated as a result of an order.

Including related resources

The endpoint also supports -to some degree- the inclusion of information of related resources. To get the details of related entities the include parameter must be added to the URI in the following way:

• GET {host}/v3/shipments?include=shipmentItems will return the shipment with all shipmentItems details.

Limitations of GET v3/shipments/:id

• When using this endpoint, expect the following limits on the result set
  • Shipments older than 90 days are not returned using this method.
  • Some shipment statusses are blocked when retreiving shipments in bulk using the GET v3/shipments but when requesting the shipment through GET v3/shipments/:id direcly may yield results.
• Users are rate-limited to 1000 requests per hour on this service.

Request

Responses

200

A successful response consists of exactly one shipment resource being returned as part of the data element in the response body. If no shipment was found under the specified id a 404 Not Found message would be returned.

401

401 Unauthorized

A 401 Unauthorized response occurs when attempting to access a resource or perform an action that requires authentication, but no valid credentials have been provided. It indicates that the requester is unauthorized to access the requested resource.

The following are common scenarios that may lead to a 401 Unauthorized response:

• Attempting to access a protected API endpoint without providing authentication credentials.
• Providing an invalid or expired authentication token.
• Providing valid authentication credentials, but lacking sufficient privileges to access the requested resource.
• Providing authentication credentials that are valid for a different resource or API endpoint than the one being requested.

403

403 Forbidden

The HTTP 403 Forbidden client error response status code indicates that the server understood the request but refused to process it. This status is similar to 401 Unauthorized, except that for 403 Forbidden responses, authenticating or re-authenticating makes no difference. The request failure is tied to application logic, such as insufficient permissions to a resource or action.

404

404 Not Found

A 404 Not Found response occurs when attempting to access a resource that cannot be found on the server. It indicates that the requested resource does not exist, either because it has been deleted, the URL is incorrect or because the endpoint has not been realized.

The following are common scenarios that may lead to a 404 Not Found response:

• Attempting to access an endpoint with an invalid or non-existent URL.
• Attempting to access an endpoint that has not (yet) been realized
• Requesting a resource that has been deleted or moved.

406

406 Not Acceptable

A 406 Not Acceptable response occurs when the server cannot provide a response that matches the client's requested format or content language for the requested resource. For instance, if a client sends an Accept header of text/html to an API endpoint that only supports application/json responses, the server would respond with a 406 Not Acceptable status code. This type of response is a required response for JSON:API compatible endpoints.

415

415 Unsupported Media Type

A 415 Unsupported Media Type response occurs when the server cannot process the request because the media type specified in the request is not supported for the requested resource. For example, if a client sends a request with a Content-Type header of application/pdf to an API endpoint that only supports application/json (the only valid media type for JSON:API), the server would respond with a 415 Unsupported Media Type status code. This type of error-response is a required for JSON:API compatible endpoints.

429

429 Too Many Requests

The request could not be completed because of a rate limit violation.