UKuk-hydrographic-office
DRAFT

POST /v1/orders

Changed on

Submit a new S100 product order for a specified licence.

Request

  • Base URL
    https://shop-facade-service-url
  • Auth
    HTTP bearer

Request body

purchaseOrderNumberstring

Not Required. A reference given to an order by the Distributor.

licenceIdinteger 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.

deliveryFromDatestring 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).

deliveryToDatestring 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.

deliveryAddressstring

Not required on "digital" only orders. Optional on orders including "paper" products. A delivery address of an order.

Response

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

orderIdinteger
accountIdinteger
messagesResponseMessage[]

Changes