---
title: "POST /v1/orders"
method: POST
path: "/v1/orders"
tags: ["DRAFT"]
---

# POST /v1/orders

`POST /v1/orders`

## Request

- Base URL: `https://shop-facade-service-url`
- URL: `https://shop-facade-service-url/v1/orders`
- Auth: HTTP bearer

Submit a new S100 product order for a specified licence.

## Request body

- OrderRequest
  - `purchaseOrderNumber` string: Not Required. A reference given to an order by the Distributor.
  - `licenceId` integer, required: Required. The unique Licence ID given to each Vessel by the UKHO.
  - `ARCSRenewType` 'New' | 'Add' | 'Renew': Required if the ARCS licence is within the last month before renewal. The type of order required if ordering ARCS products.
  - `ADPRenewType` 'New' | 'Add' | 'Renew': Required if the ADP licence is within the last month before renewal. The type of order required if ordering ADP products. "Renew" -- Add ADP products to current licence and renew licence.
  - `deliveryFromDate` string, date-time: Not required on "digital" only orders. Optional on orders including "paper" products. The required delivery from date (earliest delivery date), must be today's date or later. (Note: The time element is stored but not displayed in e-Navigator). Format: UTC YYYY-MM-DDThh:mm:ss E.g. 2012-1102T14:28:37.6613351+00:00 (Time and offset optional).
  - `deliveryToDate` string, date-time: Not required on "digital" only orders. Optional on orders including "paper" products. The required delivery to date (latest delivery date), must be today's date or later. (Note: The time element is stored but not displayed in e-Navigator). Format: UTC YYYY-MM-DDThh:mm:ss E.g. 2012-1102T14:28:37.6613351+00:00 (Time and offset optional).
  - `deliveryMethod` 'Email' | 'Download' | 'Both', required: Required. Permits and/or activation keys are provided either as downloads through GetOrder service or by email. The possible values: Email, Download, or Both.
  - `deliveryAddress` string: Not required on "digital" only orders. Optional on orders including "paper" products. A delivery address of an order.
  - `orderItems` OrderItems[], required: Required. The items in the order.
    - `productType` 'S101' | 'S102' | 'S104' | 'S111', required: Required. The product type of the product to be ordered.
    - `productId` string, required: Required. The product ID of the product to be ordered from the current S100 catalogue, of the relevant product type. NOTE: this is case sensitive.
    - `productPeriod` integer: Required for S100 Charts. The period the product is required for in months. Accepts only: 3, 6, 9, or 12.
    - `quantity` integer: Required for "paper" products. Not required for other products. The quantity of product required.

## Response `202`

Accepted - Indicates that the S100 Order has been accepted and sent for processing. Please see response for the status of each ordered product.

- SubmitOrderResponse
  - `orderId` integer
  - `accountId` integer
  - `messages` ResponseMessage[]
  - `orderStatus` OrderItemStatus[]
    - `product` string
    - `status` string

## Other responses

- `400`: Bad Request - The request is incomplete or fails validation:<br /> - Missing the JWT<br /> - Incorrect or missing data, please see response message for more details<br /> - Invalid Purchase Order Number (must be A-Z, a-z, 0-9 or _, and no more than 20 characters)
- `401`: Token Authentication Failed
- `403`: Forbidden or Quota Exceeded.<br />This will either be because: <br /> - you have no permission to use this API (in which case the body will be empty)<br /> - another distributor is responsible for a product you're trying to order on this licence <br /> - the quota has been exceeded
- `404`: Licence not found or Licence ID not provided.
- `409`: Conflict. Your order reference conflicts with a previous order reference.
- `500`: Internal Server Error.

## Changes

- **2025-02-17** `8ebefb665fe6`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/uk-hydrographic-office/apis/ukho-shop-facade-service-apis/changes/v1/orders/post.md)

---

[API](https://skmtc.dev/uk-hydrographic-office/apis/ukho-shop-facade-service-apis.md) - [All operations](https://skmtc.dev/uk-hydrographic-office/apis/ukho-shop-facade-service-apis/llms.txt) - [OpenAPI document](https://skmtc.dev/uk-hydrographic-office/apis/ukho-shop-facade-service-apis/revisions/1e0e14893f16?raw)