Update Purchase Order Document

SecurityAPIKeyHeader
Request
path Parameters
document_id
required
string (Document Id)
order_id
required
string (Order Id)
Request Body schema: application/json
required
description
string (Description) <= 64 characters

Description of the document

type
string (DocumentType)
Default: "OTHER"

An enumeration.

Enum: "BOL" "FUEL" "LUMPER" "HOS" "SIGNATURE" "RATE_CONFIRMATION" "DELIVERY_RECEIPT" "WEIGHT_CERTIFICATE" "OVERAGES_SHORTAGES_AND_DAMAGES" "INVOICE" "INVENTORY_RELEASE" "INSURANCE" "CUSTOMS_PAPERWORK" "PACKING_SLIPS" "OTHER"
Responses
200

Successful Response

Response Schema: application/json
id
required
string (Id)

Unique identifier for the Document

filename
required
string (Filename) <= 128 characters
created_at
required
string <date-time> (Created At)

Timestamp of when the document was created

updated_at
required
string <date-time> (Updated At)

Timestamp of when the document was updated

description
string (Description)
type
string (DocumentType)
Default: "OTHER"

An enumeration.

Enum: "BOL" "FUEL" "LUMPER" "HOS" "SIGNATURE" "RATE_CONFIRMATION" "DELIVERY_RECEIPT" "WEIGHT_CERTIFICATE" "OVERAGES_SHORTAGES_AND_DAMAGES" "INVOICE" "INVENTORY_RELEASE" "INSURANCE" "CUSTOMS_PAPERWORK" "PACKING_SLIPS" "OTHER"
created_by_user_id
string (Created By User Id)

ID of the user that created the document

url
required
string (Url)

Publicly available URL to file

400

Validation Error

put/purchase-orders/{order_id}/documents/{document_id}
Request samples
application/json
{
  • "description": "string",
  • "type": "OTHER"
}
Response samples
application/json
{
  • "id": "string",
  • "filename": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "updated_at": "2019-08-24T14:15:22Z",
  • "description": "string",
  • "type": "OTHER",
  • "created_by_user_id": "string",
  • "url": "string"
}
Copyright © Shipwell 2024. All right reserved.