Skip to main content
DELETE
/
api
/
rest
/
shipments
Delete One Shipment By Source System Id
curl --request DELETE \
  --url https://api.upwell.com/api/rest/shipments \
  --header 'Content-Type: application/json' \
  --data '
{
  "sourceSystem": "<string>",
  "sourceSystemId": "<string>"
}
'
{
  "deleteShipment": {
    "affectedRows": 123,
    "returning": [
      {
        "id": "<string>"
      }
    ]
  }
}

Headers

​
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Query Parameters

​
sourceSystem
string

"sourceSystem" is required (enter it either in parameters or request body)

​
sourceSystemId
string

"sourceSystemId" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

​
sourceSystem
string
​
sourceSystemId
string

Response

200 - application/json

Responses for DELETE /api/rest/shipments

​
deleteShipment
ShipmentsMutationResponse · object

response of any mutation on the table "shipments"