Update a shipment document's effective date. The document's visibility and status are preserved.

PUT

https://api.test.post-plus.io/api/v1/shipments/{shipmentId}/shipment-documents/{fileId}

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Path Params

Header Params

Body Params

application/json-patch+json

Example

{
    "effectiveDate": "2019-08-24T14:15:22.123Z",
    "effectiveBags": 0
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.test.post-plus.io/api/v1/shipments//shipment-documents/' \
--header 'Accept: application/json' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "effectiveDate": "2019-08-24T14:15:22.123Z",
    "effectiveBags": 0
}'

Responses

🟢200

This response does not have a body.

Add tracking event with generic payload.

Resolve HS codes by list of descriptions.