Edit an order

Updates an existing order. Only orders that have not been submitted and are for allowed products can be edited. You can update the company and jurisdictions.

patch/orders/{id}

Request

Base URL
https://www.harborcompliance.com/api/v1
Auth
OAuth 2
Authorization code/api/v1/oauth/authorize
Token URL/api/v1/oauth/access_token
TypeScript
https://skmtc.dev/harborcompliance/apis/harbor-compliance-api/docs/orders/:id/patch.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

Resource UUID

Request body

mark_orderedboolean

Marks the Order as ordered without waiting for payment. This feature must be enabled on the Account the Order is for.

Example request

{
  "jurisdictions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

Response

Order updated successfully

Example response

{
  "data": {
    "company": {
      "domicile": {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      },
      "principal_address": {
        "administrative_area": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      },
      "mailing_address": {
        "administrative_area": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        },
        "country": {
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    },
    "jurisdictions": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.