Shipment Delivered

1 min

POST

https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/delivered

This endpoint allows administrators to flag a shipment as delivered.

Authorized permissions:

order.update

orderIdstring<uuid>The parameterized order id in the URI.

shipmentIdstring<uuid>Unique identifier for the shipment that needs to be transitioned.

x-upstart-tenantstringTenant identifier associated with the site this call is for.

200<p>Success-shipment successfully flagged as delivered.</p>

401The provided credentials were not valid for this endpoint. It may be that they are expired or that the user's roles are insufficient.

404The requested resource was not found in the NoChannel system.

curl --request POST \
     --url https://api.upstartcommerce.com/v1/order/{orderId}/shipments/{shipmentId}/delivered \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'