Skip to main content
DELETE
/
api
/
rest
/
shipments
/
{shipmentId}
/
documents
/
{id}
Delete Shipment Document
curl --request DELETE \
  --url https://api.upwell.com/api/rest/shipments/{shipmentId}/documents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "id": "<string>",
  "shipmentId": "<string>"
}
'
{
  "deleteFileAssociations": {
    "affectedRows": 123,
    "returning": [
      {
        "associationId": "<string>",
        "fileId": "<string>",
        "id": "<string>"
      }
    ]
  }
}

Headers

authorization
string

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

Path Parameters

id
string
required

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

shipmentId
string
required

"shipmentId" 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

id
string
shipmentId
string

Response

200 - application/json

Responses for DELETE /api/rest/shipments/{shipmentId}/documents/{id}

deleteFileAssociations
FileAssociationsMutationResponse Ā· object

response of any mutation on the table "file_associations"