Gormic.com

Order Lines

Creates a new order line.

post
Body
Responses
200Success
application/json
post
POST /v1/om/orders-lines HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "params": {
    "orderId": "text",
    "productId": "text",
    "quantity": 1,
    "seats": [
      1
    ],
    "course": 1,
    "status": 1,
    "invoiceId": "text",
    "comboLineId": "text",
    "comboOptionUid": "text",
    "price": 1,
    "skipCalculate": true,
    "note": "text",
    "locked": true
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "id": "text"
  }
}

Deletes a draft order line.

delete
Path parameters
idstringRequired
Responses
200Success
application/json
delete
DELETE /v1/om/orders-lines/{id} HTTP/1.1
Host: 
Accept: */*
200Success
{
  "params": {
    "id": "text",
    "orderId": "text"
  }
}

Updates an order line.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 135

{
  "params": {
    "id": "text",
    "orderId": "text",
    "quantity": 1,
    "seats": [
      1
    ],
    "status": 1,
    "course": 1,
    "note": "text",
    "invoiceId": "text",
    "locked": true
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Voids an order line.

patch
Path parameters
idstringRequired
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/void HTTP/1.1
Host: 
Accept: */*
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Applies a modifier to order line.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/modify HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 114

{
  "params": {
    "orderId": "text",
    "lineId": "text",
    "modifierId": "text",
    "options": [
      {
        "id": "text",
        "quantity": 1,
        "price": 1
      }
    ]
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Applies a modifier to order line.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/update-modifier HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 104

{
  "params": {
    "orderId": "text",
    "lineId": "text",
    "modifierId": "text",
    "modifierOptionId": "text",
    "quantity": 1
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Applies a discount at line level

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/discount HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "params": {
    "orderId": "text",
    "lineId": "text",
    "discountId": "text",
    "reasonId": "text",
    "comment": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Updates applied discount at line level.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/update-discount HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 100

{
  "params": {
    "orderId": "text",
    "lineId": "text",
    "discountId": "text",
    "reasonId": "text",
    "comment": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {
    "succeed": true
  }
}

Cancels a discount at order level.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/cancel-discount HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 65

{
  "params": {
    "orderId": "text",
    "lineId": "text",
    "discountId": "text"
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}

Applies a custom discount at line level.

patch
Path parameters
idstringRequired
Body
Responses
200Success
application/json
patch
PATCH /v1/om/orders-lines/{id}/custom-discount HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 207

{
  "params": {
    "type": 1,
    "orderId": "text",
    "lineId": "text",
    "value": 1,
    "excludeTax": true,
    "source": 1,
    "sourceId": "text",
    "locales": {
      "ar": {
        "name": "text",
        "description": "text"
      },
      "en": {
        "name": "text",
        "description": "text"
      }
    }
  }
}
200Success
{
  "app": "text",
  "service": "text",
  "warnings": [
    {}
  ],
  "instanceId": "text",
  "requestId": "text",
  "data": {}
}
PreviousOrdersNextPayments

Was this helpful?