Order Lines

Creates a new order line.

post

Authorizations

api-key

api-keystringRequired

API Key

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

post

/v1/om/order-lines

HTTPcURLJavaScriptPython

POST /v1/om/order-lines HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 225

{
  "params": {
    "orderId": "text",
    "productId": "text",
    "quantity": 1,
    "seats": [
      1
    ],
    "course": 1,
    "status": "Comped",
    "invoiceId": "text",
    "comboLineId": "text",
    "comboOptionUid": "text",
    "price": 1,
    "skipCalculate": true,
    "note": "text",
    "locked": true
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "id": "text"
  }
}

Deletes a draft order line.

delete

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Responses

200Success

application/json

400

Functional Error

application/json

delete

/v1/om/order-lines/{uid}

HTTPcURLJavaScriptPython

DELETE /v1/om/order-lines/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Accept: */*

{
  "params": {
    "id": "text",
    "orderId": "text"
  }
}

Updates an order line.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid} HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 113

{
  "params": {
    "quantity": 1,
    "seats": [
      1
    ],
    "status": "Comped",
    "course": 1,
    "note": "text",
    "invoiceId": "text",
    "locked": true
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Voids an order line.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/void

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/void HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 43

{
  "params": {
    "waste": true,
    "reasonId": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Applies a modifier to order line.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/apply-modifier

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/apply-modifier HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "params": {
    "modifierId": "text",
    "options": [
      {
        "id": "text",
        "quantity": 1,
        "price": 1
      }
    ]
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Updates applied modifier option.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/update-modifier

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/update-modifier HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "params": {
    "modifierId": "text",
    "modifierOptionId": "text",
    "quantity": 1
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Applies a discount at line level

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/discount

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/discount HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "params": {
    "discountId": "text",
    "reasonId": "text",
    "comment": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Updates applied discount at line level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/update-discount

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/update-discount HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 67

{
  "params": {
    "discountId": "text",
    "reasonId": "text",
    "comment": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Cancels a discount at order level.

patch

Authorizations

api-key

api-keystringRequired

API Key

Path parameters

uidstringRequired

Header parameters

organization-idstringRequired

Organization ID

Body

application/json

Responses

200Success

application/json

400

Functional Error

application/json

patch

/v1/om/order-lines/{uid}/cancel-discount

HTTPcURLJavaScriptPython

PATCH /v1/om/order-lines/{uid}/cancel-discount HTTP/1.1
Host: 
api-key: YOUR_API_KEY
organization-id: text
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "params": {
    "discountId": "text"
  }
}

{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}