comecerodocs
Shipments

Delete a shipment

DELETE
/shipments/{shipment_id}

Deletes a shipment, for example one entered by mistake. Order items that no longer have all their units shipped are marked not fulfilled again, and so is the order. A payment already captured stays captured. The shipment:deleted event fires.

Needs a secret or trusted token. Limited tokens get 403.

Authorization

headerAuthorizationBearer <token>

A secret, trusted or limited token. See Authentication.

Path Parameters

shipment_id*string

The shipment id.

Response Body

The shipment was deleted. No body.

Example Request
curl -X DELETE 'https://api.comecero.com/api/v1/shipments/string'
Example Response
Empty

Update a shipment POST

Changes the date shipped, carrier, tracking number, tracking URL or `meta` of a shipment. The items cannot be changed. The `shipment:modified` event fires. The customer is not emailed again. Needs a secret or trusted token. Limited tokens get `403`.

List a shipment's notifications GET

Lists the emails sent to the customer about this shipment, such as the shipment confirmation. Offset-based (`offset`, `limit`). `sort_by` takes `date_created` (default) or `date_modified`. A limited token may call this for a shipment it is bound to.