Custom Orders | Subrite

Custom Orders

Endpoints for Custom Orders

ReferenceUpdated October 13, 2026View as Markdown

Create or update a custom order#

POST/api/v1/custom-orders

Authentication: Bearer token (JWT)

Request body

Required bodyapplication/json

SchemaCreateCustomOrderDto

9 top-level fieldsSelect an object to expand

sourceIdstring (uuid)Required
sourceRefstringRequired
maxLength: 255
memberIdstringRequired
maxLength: 255
totalPricenumberRequired
totalPriceVatnumberRequired
currencystringRequired
minLength: 3maxLength: 3
orderTimestringOptional
itemsarray of CreateCustomOrderItemDtoRequired7 required when the containing object is present8 fields
items
minItems: 1
- productIdstringRequired when parent is presentField path: items[].productId
  maxLength: 255
- productNamestringRequired when parent is presentField path: items[].productName
  maxLength: 255
- categoryIdstringRequired when parent is presentField path: items[].categoryId
  maxLength: 255
- categoryName
customPropertyValuesobjectOptional

17 documented fields · Scroll to see moreShow full heightShow compact view

Responses

5 status codes

Responses 201

Status201 400 401 403 500application/json

Order created/updated successfully

Schema ExampleCustomOrder

18 top-level fieldsSelect an object to expand

orderTimestring (date-time)Required
memberIdstringRequired
sourceIdstringRequired

Example requestcurl

curl

curl https://api.subrite.no/api/v1/custom-orders \
  --request POST \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "sourceId": "797f5a94-3689-4ac8-82fd-d749511ea2b2",
  "sourceRef": "string",
  "memberId": "string",
  "totalPrice": 0,
  "totalPriceVat": 0,
  "currency": "str",
  "orderTime": "string",
  "items": [
    {
      "customPropertyValues": {}
    }
  ],
  "customPropertyValues": {}
}'

Try it

GET/api/v1/custom-orders/member/{memberId}

Authentication: Bearer token (JWT)

Parameters

Path parameters1

memberIdstringRequired

Query parameters4

pagenumberOptional
Default: 1minimum: 1
takenumberOptional
Default: 10minimum: 1maximum: 50
orderBystringOptional
Default:

GET/api/v1/custom-orders/member/{memberId}/{orderId}

Authentication: Bearer token (JWT)

Parameters

Path parameters2

memberIdstringRequired
orderIdstringRequired

Responses

6 status codes

Responses 200

Status200 400 401 403 404 500application/json

string

Schema ExampleCustomOrder

201 · application/json

{
  "orderTime": "2019-08-24T14:15:22Z",
  "memberId": "string",
  "sourceId": "string",
  "sourceRef": "string",
  "totalPrice": 0,
  "totalPriceVat": 0,
  "currency": "string",
  "tenantId": 0,
  "customPropertyValues": {},
  "tenant": {
    "market": "NO",
    "productName": "enterprise",
    "additionalFeatures": [],
    "disabledFeatures": [],
    "name": "string",
    "isActive": true,
    "defaultLanguage": "en",
    "hostName": "string",
    "logo": "string",
    "favicon": "string",
    "authLogo": "string",
    "authLogoHeight": 0,
    "siteUrl": "string",
    "termsUrl": "string",
    "privacyUrl": "string",
    "gtm": "string",
    "taxRates": [],
    "smsOtp": true,
    "emailProvider": "brevo",
    "tenantContact": "string",
    "registeredBusinessNo": "string",
    "bankAccountNo": "string",
    "swiftCode": "string",
    "iban": "<iban>",
    "defaultLogoutURL": "string",
    "postalAddress": "<postalAddress>",
    "otpTemplateId": {},
    "smsSenderId": 0,
    "emailSenderId": 0,
    "smsSender": {
      "metaData": {}
    },
    "emailSender": {
      "metaData": {}
    },
    "products": [],
    "users": [],
    "members": [],
    "roles": [],
    "subscriptionPlans": [],
    "packages": [],
    "invoices": [],
    "orders": [],
    "paymentProviders": [],
    "newslettersProviderConfig": [],
    "paymentProviderConfigs": [],
    "oidcClients": [],
    "oauthProviders": [],
    "activityLogs": [],
    "m2m_api_clients": [],
    "customProperties": [],
    "consents": [],
    "preference": {
      "inputFieldConfig": [],
      "customFieldsOnMemberCard": [],
      "customFieldsOnInvoice": [],
      "visibleAdditionalFieldsOnMypage": [],
      "metaData": {}
    },
    "settings": {
      "aiResidency": {},
      "metaData": {}
    },
    "communicationTemplates": [],
    "additionalHostnames": [],
    "exportHistory": [],
    "arReportHistory": [],
    "mypageCardsSettings": [],
    "webhooks": [],
    "customOrders": [],
    "customOrderSources": [],
    "brandKits": [],
    "communicationReceivers": [],
    "id": 0,
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "source": {
    "name": "string",
    "tenantId": 0,
    "tenant": {
      "additionalFeatures": [],
      "disabledFeatures": [],
      "taxRates": [],
      "products": [],
      "users": [],
      "members": [],
      "roles": [],
      "subscriptionPlans": [],
      "packages": [],
      "invoices": [],
      "orders": [],
      "paymentProviders": [],
      "newslettersProviderConfig": [],
      "paymentProviderConfigs": [],
      "oidcClients": [],
      "oauthProviders": [],
      "activityLogs": [],
      "m2m_api_clients": [],
      "customProperties": [],
      "consents": [],
      "communicationTemplates": [],
      "additionalHostnames": [],
      "exportHistory": [],
      "arReportHistory": [],
      "mypageCardsSettings": [],
      "webhooks": [],
      "customOrders": [],
      "customOrderSources": [],
      "brandKits": [],
      "communicationReceivers": [],
      "metaData": {}
    },
    "orders": [],
    "id": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "deletedAt": "2019-08-24T14:15:22Z",
    "metaData": {}
  },
  "items": [
    {
      "customPropertyValues": {},
      "metaData": {}
    }
  ],
  "feedProcessed": true,
  "id": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "updatedAt": "2019-08-24T14:15:22Z",
  "deletedAt": "2019-08-24T14:15:22Z",
  "metaData": {}
}

Example · 146 linesShow full heightShow compact view

Responses 400

Status201 400 401 403 500application/json

badRequest, customOrderSourceNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest", "customOrderSourceNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is present

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status201 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- messagestringField path: errors[].message
- errorTypestringRequired when parent is presentField path: errors[].errorType

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

"createdAt"

Responses

5 status codes

Responses 200

Status200 400 401 403 500application/json

Schema ExampleCustomOrderResponseDtoPaginated

2 top-level fieldsSelect an object to expand

itemsarray of CustomOrderResponseDtoRequired8 fields
items
- idstringRequired when parent is presentField path: items[].id
- orderTimestring (date-time)Required when parent is presentField path: items[].orderTime
- sourceRefstringRequired when parent is presentField path: items[].sourceRef
- sourceNamestringRequired when parent is presentField path: items[].sourceName
- totalPricenumberRequired when parent is presentField path: items[].totalPrice
- totalPriceVatnumberRequired when parent is presentField path: items[].totalPriceVat
- currencystringRequired when parent is presentField path: items[].currency
- itemsarray of CustomOrderItemResponseDtoField path: items[].items8 fields
  items[].items
  - idstringRequired when parent is presentField path: items[].items[].id
  - productIdstringRequired when parent is presentField path: items[].items[].productId
  - productNamestringRequired when parent is presentField path: items[].items[].productName
  - categoryIdstringRequired when parent is presentField path: items[].items[].categoryId
  - categoryNamestringRequired when parent is presentField path: items[].items[].categoryName
metaPageMetaRequired6 fields
meta
- pagenumberRequiredField path: meta.page
- takenumberRequiredField path: meta.take
- countnumberRequiredField path: meta.count
- pageCountnumberRequiredField path: meta.pageCount
- hasPreviousPagebooleanRequiredField path: meta.hasPreviousPage
- hasNextPagebooleanRequiredField path: meta.hasNextPage

24 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleCustomOrderResponseDtoPaginated

200 · application/json

{
  "items": [
    {
      "items": []
    }
  ],
  "meta": {
    "page": 0,
    "take": 0,
    "count": 0,
    "pageCount": 0,
    "hasPreviousPage": true,
    "hasNextPage": true
  }
}

Example · 15 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 500application/json

badRequest

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "badRequest"
messagestring

Responses 401

unauthorized

This response has no body.

Responses 403

Status200 400 401 403 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Create or update a custom order (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Responses 500

Status200 400 401 403 500application/json

internalServerError

SchemaErrorResponse

Same fields as Create or update a custom order (403).

Schema ExampleCustomOrderResponseDto

200 · application/json

{
  "id": "string",
  "orderTime": "2019-08-24T14:15:22Z",
  "sourceRef": "string",
  "sourceName": "string",
  "totalPrice": 0,
  "totalPriceVat": 0,
  "currency": "string",
  "items": [
    {}
  ]
}

Example · 12 linesShow full heightShow compact view

Responses 400

Status200 400 401 403 404 500application/json

badRequest

Schema ExampleErrorResponse

Same fields as List custom orders for a member (paginated) (400).

Schema ExampleErrorResponse

400 · application/json

{
  "messageCode": "badRequest",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 403

Status200 400 401 403 404 500application/json

forbiddenResource

Schema ExampleErrorResponse

Same fields as Create or update a custom order (403).

Schema ExampleErrorResponse

403 · application/json

{
  "messageCode": "string",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

Responses 404

Status200 400 401 403 404 500application/json

customOrderNotFound

Schema ExampleErrorResponse

3 top-level fieldsSelect an object to expand

messageCodestringRequired
Allowed values: "customOrderNotFound"
messagestring
errorsarray of FieldErrorRequired7 fields
errors
- fieldstringRequired when parent is presentField path: errors[].field
- fieldValuestringRequired when parent is presentField path: errors[].fieldValue
- identifierstringRequired when parent is presentField path: errors[].identifier
- identifierValuestringRequired when parent is presentField path: errors[].identifierValue
- messageCodestringRequired when parent is presentField path: errors[].messageCode
- message

10 documented fields · Scroll to see moreShow full heightShow compact view

Schema ExampleErrorResponse

404 · application/json

{
  "messageCode": "customOrderNotFound",
  "message": "string",
  "errors": [
    {}
  ]
}

Example · 7 linesShow full heightShow compact view

errors

array of FieldError

string

Custom Orders

Create or update a custom order#

Request body

Responses

Responses 201

List custom orders for a member (paginated)#

Parameters

Get a single custom order with line items#

Parameters

Responses

Responses 200

Create or update a custom order#

Request body

Responses

Responses 201

List custom orders for a member (paginated)#

Parameters

Get a single custom order with line items#

Parameters

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses

Responses 200

Responses 400

Responses 401

Responses 403

Responses 500

Responses 400

Responses 401

Responses 403

Responses 404

Responses 500