# [Not Implemented] Get order

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/llms.txt.
> For full documentation content, see https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/llms-full.txt.

GET http://localhost:8080/api/v1/orders/{orderId}

> **Status: Not Implemented**

Retrieve an order by ID from the specified POS system.


Reference: https://apidocs.cata.sg/pos-integration-service-api/api/v-1/orders/order-id/not-implemented-get-order

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: collection
  version: 1.0.0
paths:
  /api/v1/orders/{orderId}:
    get:
      operationId: not-implemented-get-order
      summary: '[Not Implemented] Get order'
      description: |
        > **Status: Not Implemented**

        Retrieve an order by ID from the specified POS system.
      tags:
        - >-
          subpackage_api.subpackage_api/v1.subpackage_api/v1/orders.subpackage_api/v1/orders/orderId
      parameters:
        - name: orderId
          in: path
          description: Order identifier
          required: true
          schema:
            type: string
        - name: posType
          in: query
          description: Type of POS system
          required: false
          schema:
            type: string
        - name: X-Api-Key
          in: header
          required: true
          schema:
            type: string
        - name: X-Tenant-ID
          in: header
          description: Tenant identifier
          required: false
          schema:
            type: string
        - name: X-Store-ID
          in: header
          description: Store identifier
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/api_v1_orders_{orderId}_[Not Implemented]
                  Get order_Response_200
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1OrdersOrderidRequestNotFoundError'
servers:
  - url: http://localhost:8080
components:
  schemas:
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsUnitPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsUnitPrice
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsTotalPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsTotalPrice
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsPrice:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsPrice
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsMetadata:
      type: object
      properties:
        key_0:
          type: number
          format: double
        key_1:
          type: integer
      required:
        - key_0
        - key_1
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsMetadata
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItems:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        price:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsPrice
        quantity:
          type: integer
        externalId:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItemsMetadata
      required:
        - id
        - name
        - price
        - quantity
        - externalId
        - metadata
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItems
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsMetadata:
      type: object
      properties:
        key_0:
          type: string
        key_1:
          type: integer
      required:
        - key_0
        - key_1
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsMetadata
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItems:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        quantity:
          type: integer
        unitPrice:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsUnitPrice
        externalId:
          type: string
        description:
          type: string
        totalPrice:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsTotalPrice
        modifiers:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsModifiersItems
        specialInstructions:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItemsMetadata
      required:
        - id
        - name
        - quantity
        - unitPrice
        - externalId
        - description
        - totalPrice
        - modifiers
        - specialInstructions
        - metadata
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItems
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTotalAmount:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTotalAmount
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomerAddress:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
      required:
        - street
        - city
        - state
        - postalCode
        - country
        - latitude
        - longitude
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomerAddress
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomer:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
          format: email
        phone:
          type: string
        address:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomerAddress
      required:
        - id
        - name
        - email
        - phone
        - address
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomer
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaSubtotal:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaSubtotal
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTax:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTax
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTip:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTip
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryFee:
      type: object
      properties:
        amount:
          type: integer
        currency:
          type: string
      required:
        - amount
        - currency
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryFee
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryAddress:
      type: object
      properties:
        street:
          type: string
        city:
          type: string
        state:
          type: string
        postalCode:
          type: string
        country:
          type: string
        latitude:
          type: number
          format: double
        longitude:
          type: number
          format: double
      required:
        - street
        - city
        - state
        - postalCode
        - country
        - latitude
        - longitude
      title: >-
        ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryAddress
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaMetadata:
      type: object
      properties:
        key_0:
          type: string
      required:
        - key_0
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaMetadata
    api_v1_orders_{orderId}_[Not Implemented] Get order_Response_200:
      type: object
      properties:
        id:
          type: string
        storeId:
          type: string
        items:
          type: array
          items:
            $ref: >-
              #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaItemsItems
        totalAmount:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTotalAmount
        status:
          type: string
        externalId:
          type: string
        channelOrderId:
          type: string
        channelName:
          type: string
        customer:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaCustomer
        subtotal:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaSubtotal
        tax:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTax
        tip:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaTip
        deliveryFee:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryFee
        orderType:
          type: string
        scheduledFor:
          type: string
          format: date-time
        estimatedDeliveryTime:
          type: string
          format: date-time
        pickupTime:
          type: string
          format: date-time
        deliveryAddress:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaDeliveryAddress
        notes:
          type: string
        metadata:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaMetadata
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - storeId
        - items
        - totalAmount
        - status
        - externalId
        - channelOrderId
        - channelName
        - customer
        - subtotal
        - tax
        - tip
        - deliveryFee
        - orderType
        - scheduledFor
        - estimatedDeliveryTime
        - pickupTime
        - deliveryAddress
        - notes
        - metadata
        - createdAt
        - updatedAt
      title: api_v1_orders_{orderId}_[Not Implemented] Get order_Response_200
    ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaError:
      type: object
      properties:
        code:
          type: integer
        message:
          type: string
        details:
          type: string
        field:
          type: string
      required:
        - code
        - message
        - details
        - field
      title: ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaError
    GetApiV1OrdersOrderidRequestNotFoundError:
      type: object
      properties:
        error:
          $ref: >-
            #/components/schemas/ApiV1OrdersOrderIdGetResponsesContentApplicationJsonSchemaError
      required:
        - error
      title: GetApiV1OrdersOrderidRequestNotFoundError
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: X-Api-Key

```

## SDK Code Examples

```python api_v1_orders_{orderId}_[Not Implemented] Get order_example
import requests

url = "http://localhost:8080/api/v1/orders/string"

querystring = {"posType":"DELIVERECT"}

headers = {
    "X-Tenant-ID": "string",
    "X-Store-ID": "string",
    "X-Api-Key": "<apiKey>"
}

response = requests.get(url, headers=headers, params=querystring)

print(response.json())
```

```javascript api_v1_orders_{orderId}_[Not Implemented] Get order_example
const url = 'http://localhost:8080/api/v1/orders/string?posType=DELIVERECT';
const options = {
  method: 'GET',
  headers: {'X-Tenant-ID': 'string', 'X-Store-ID': 'string', 'X-Api-Key': '<apiKey>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go api_v1_orders_{orderId}_[Not Implemented] Get order_example
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:8080/api/v1/orders/string?posType=DELIVERECT"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Tenant-ID", "string")
	req.Header.Add("X-Store-ID", "string")
	req.Header.Add("X-Api-Key", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby api_v1_orders_{orderId}_[Not Implemented] Get order_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v1/orders/string?posType=DELIVERECT")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["X-Tenant-ID"] = 'string'
request["X-Store-ID"] = 'string'
request["X-Api-Key"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java api_v1_orders_{orderId}_[Not Implemented] Get order_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("http://localhost:8080/api/v1/orders/string?posType=DELIVERECT")
  .header("X-Tenant-ID", "string")
  .header("X-Store-ID", "string")
  .header("X-Api-Key", "<apiKey>")
  .asString();
```

```php api_v1_orders_{orderId}_[Not Implemented] Get order_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'http://localhost:8080/api/v1/orders/string?posType=DELIVERECT', [
  'headers' => [
    'X-Api-Key' => '<apiKey>',
    'X-Store-ID' => 'string',
    'X-Tenant-ID' => 'string',
  ],
]);

echo $response->getBody();
```

```csharp api_v1_orders_{orderId}_[Not Implemented] Get order_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v1/orders/string?posType=DELIVERECT");
var request = new RestRequest(Method.GET);
request.AddHeader("X-Tenant-ID", "string");
request.AddHeader("X-Store-ID", "string");
request.AddHeader("X-Api-Key", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift api_v1_orders_{orderId}_[Not Implemented] Get order_example
import Foundation

let headers = [
  "X-Tenant-ID": "string",
  "X-Store-ID": "string",
  "X-Api-Key": "<apiKey>"
]

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v1/orders/string?posType=DELIVERECT")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```