---
title: "This endpoint updates an orders metadata"
method: POST
path: "/v4.0/Orders/{orderId}/actions/updateMetadata"
tags: ["Orders"]
---

# This endpoint updates an orders metadata

`POST /v4.0/Orders/{orderId}/actions/updateMetadata`

## Path parameters

- `orderId` string, required

## Request body

- OrderUpdateOrderMetadataDto
  - `metadata` OrderJToken[]

## Response `200`

Returns the updated order details with an outcome of updated

- OrderOrderResponseDto
  - `outcome` string, nullable
  - `traceParent` string, nullable
  - `order` OrderOrderDto
    - `id` string, nullable
    - `omsId` string, nullable
    - `created` string, date-time
    - `lastUpdated` string, date-time
    - `callbackUrl` string, nullable
    - `merchantReference` string, nullable
    - `shippingMethod` string, nullable
    - `idempotencyKey` string, nullable
    - `status` OrderStatusDto
      - `stage` 0 | 1 | 2 | 3 | 4
      - `issues` OrderStatusIssueDto[], nullable
        - `objectId` string, nullable
        - `errorCode` string, nullable
        - `description` string, nullable
        - `authorisationDetails` OrderAuthorisationDetailsDto
          - `authorisationUrl` string, nullable
          - `paymentDetails` OrderCostDto
            - `amount` number, double
            - `currency` string, nullable
      - `details` OrderStatusDetailsDto
        - `downloadAssets` 0 | 1 | 2 | 3
        - `printReadyAssetsPrepared` 0 | 1 | 2 | 3
        - `allocateProductionLocation` 0 | 1 | 2 | 3
        - `inProduction` 0 | 1 | 2 | 3
        - `shipping` 0 | 1 | 2 | 3
    - `charges` OrderChargeDto[], nullable
      - `id` string, nullable
      - `prodigiInvoiceNumber` string, nullable
      - `totalCost` OrderCostDto
        - `amount` number, double
        - `currency` string, nullable
      - `totalTax` OrderCostDto
        - `amount` number, double
        - `currency` string, nullable
      - `items` OrderChargeItemDto[], nullable
        - `id` string, nullable
        - `itemId` string, nullable
        - `cost` OrderCostDto
          - `amount` number, double
          - `currency` string, nullable
        - `shipmentId` string, nullable
        - `chargeType` 0 | 1 | 2 | 3
    - `shipments` OrderShipmentDto[], nullable
      - `id` string, nullable
      - `dispatchDate` string, date-time, nullable
      - `carrier` OrderShippingCarrierDto
        - `name` string, nullable
        - `service` string, nullable
      - `fulfillmentLocation` OrderFulfillmentLocationDto
        - `countryCode` string, nullable
        - `labCode` string, nullable
      - `tracking` OrderShippingTrackingDto
        - `number` string, nullable
        - `url` string, nullable
      - `items` OrderShipmentItemDto[], nullable
        - `itemId` string, nullable
        - `availability` 0 | 1
      - `status` 0 | 1 | 2
    - `recipient` OrderRecipientDto
      - `name` string, nullable
      - `email` string, nullable
      - `phoneNumber` string, nullable
      - `address` OrderAddressDto
        - `line1` string, nullable
        - `line2` string, nullable
        - `postalOrZipCode` string, nullable
        - `countryCode` string, nullable
        - `townOrCity` string, nullable
        - `stateOrCounty` string, nullable
    - `items` OrderOrderItemDto[], nullable
      - `id` string, nullable
      - `omsId` string, nullable
      - `status` string, nullable
      - `merchantReference` string, nullable
      - `sku` string, nullable
      - `copies` integer
      - `sizing` string, nullable
      - `thumbnailUrl` string, nullable
      - `attributes` object, nullable
      - `spine` OrderSpineDto
        - `text` string, nullable
        - `backgroundColourHexCode` string, nullable
        - `textColourHexCode` string, nullable
        - `textSizePx` integer, nullable
        - `textFontFamily` string, nullable
      - `assets` OrderOrderItemAssetDto[], nullable
        - `id` string, nullable
        - `omsId` string, nullable
        - `printArea` string, nullable
        - `md5Hash` string, nullable
        - `url` string, nullable
        - `thumbnailUrl` string, nullable
        - `pageCount` integer, nullable
        - `status` 0 | 1 | 2 | 3
      - `recipientCost` OrderCostDto
        - `amount` number, double
        - `currency` string, nullable
    - `packingSlip` OrderPackingSlipDto
      - `url` string, nullable
      - `status` string, nullable
    - `branding` object, nullable
    - `metadata` OrderJToken[]
    - `tag` string, nullable
    - `usSalesTaxAlreadyCollected` boolean

## Other responses

- `400` — Returns a bad request validation error
- `401` — Unauthorized response

---

[API](https://skmtc.net/prodigi/apis/prodigi-api.md) · [All operations](https://skmtc.net/prodigi/apis/prodigi-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/prodigi/prodigi-api/revisions/697039a65afe/schema)