This is an implementation of orders data update when order data object is provided in the body.

Orders

Endpoints for retrieving the all data related to the order.

Operations

Get all data for specific data order

Request

Returns the the all data for the specific order ID. The order dara is returned only in case authorisation allows the api consumer to access the data

Security

CognitoOAuth2Test(Required scopes: ) or CognitoOAuth2Prod(Required scopes: )

Path

idstringrequired

Girteka order ID

Examples:

Valid order ID ORD123456789

Forbidden access forbidden-order

Not found not-found-order

curl -i -X GET \
  'https://api-docs.girteka.eu/_mock/orders-api/api/orders/{id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Latest metadata entry

Bodyapplication/json

idstringrequired

System Unique identifier of the Order entry. ID is created during order creation and represents Girteka systems uniq ID

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

order_idstringrequired

Girteka Internal unique identifier of the order. This is Girteka SAP ID

Example: "ORD123456789"

customer_order_idstring

Order ID provided by the Customer. In an situtation when customer does not provide customer id in order reques, this field is the same as Girteka order_id.

Example: "CUST987654321"

customer_system_idstring

System Unique identifier of the Order entry within customer systems.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

statusstring

Represents order status

Example: "In Transit"

customerobject(customer_data)

support_organisationobject(customer_care_data)

cargoobject(cargo_data)

order_stagesArray of objects(order_stage_data)

Represents Order execution flows

trackingArray of objects(gps_data)

Tracking data for the order

temperaturesobject

Response

application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "order_id": "ORD123456789",
  "customer_order_id": "CUST987654321",
  "customer_system_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "In Transit",
  "customer": {
    "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "My Best Company, UAB",
    "customer_vat": "LT123456789",
    "address": { … }
  },
  "support_organisation": {
    "phone": "000000000000",
    "email": "info@girteka.eu",
    "customer_care_id": "15"
  },
  "cargo": {
    "description": "Motocyrcles",
    "weightKg": "600",
    "volumeM3": "60"
  },
  "order_stages": [
    { … }
  ],
  "tracking": [
    { … }
  ],
  "temperatures": {
    "temperature_setting": "25.5",
    "temperature_data": [ … ]
  }
}

Get all temperature readings associated with specific order

Request

Returns all temperature readings assiciated with specific order. The temperature dara is returned only in case authorisation allows the api consumer to access the data

Security

CognitoOAuth2Test(Required scopes: ) or CognitoOAuth2Prod(Required scopes: )

Path

idstringrequired

Girteka order ID

Examples:

Valid order ID ORD123456789

Forbidden access forbidden-order

Not found not-found-order

curl -i -X GET \
  'https://api-docs.girteka.eu/_mock/orders-api/api/orders/{id}/temperatures' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Temperature readings sorted by tampstamp

Bodyapplication/jsonArray [

temperature_trailernumber

Temperature of the sensor in trailer

Example: "25.5"

timestampstring

Timestamp of the temperature reading

Example: "2025-05-06T14:30:00Z"

]

Response

application/json

[
  {
    "temperature_trailer": "25.5",
    "timestamp": "2025-05-06T14:30:00Z"
  }
]

Get latest temperature readings associated with specific order

Request

Returns latest temperature readings assiciated with specific order. The temperature dara is returned only in case authorisation allows the api consumer to access the data

Security

CognitoOAuth2Test(Required scopes: ) or CognitoOAuth2Prod(Required scopes: )

Path

idstringrequired

Girteka order ID

Examples:

Valid order ID ORD123456789

Forbidden access forbidden-order

Not found not-found-order

curl -i -X GET \
  'https://api-docs.girteka.eu/_mock/orders-api/api/orders/{id}/temperatures/latest' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Temperature readings sorted by tampstamp

Bodyapplication/json

temperature_trailernumber

Temperature of the sensor in trailer

Example: "25.5"

timestampstring

Timestamp of the temperature reading

Example: "2025-05-06T14:30:00Z"

Response

application/json

{
  "temperature_trailer": "25.5",
  "timestamp": "2025-05-06T14:30:00Z"
}

This is an implementation of orders data update when order data object is provided in the body.

Request

This is an implementation of orders data update when order data object is provided in the body. The same can be implemented either with POST method to specific order /orders/{id}. For Higfh volumes updates it is highly recomend to implement updates via messaging. Please contact order-api@girteka.eu to get access to messaging queue. Please note, that security validation is applied to check if you have rights to update specific order data

Security

CognitoOAuth2Test(Required scopes: ) or CognitoOAuth2Prod(Required scopes: )

curl -i -X POST \
  https://api-docs.girteka.eu/_mock/orders-api/api/orders \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Latest metadata entry

Bodyapplication/json

idstringrequired

System Unique identifier of the Order entry. ID is created during order creation and represents Girteka systems uniq ID

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

order_idstringrequired

Girteka Internal unique identifier of the order. This is Girteka SAP ID

Example: "ORD123456789"

customer_order_idstring

Order ID provided by the Customer. In an situtation when customer does not provide customer id in order reques, this field is the same as Girteka order_id.

Example: "CUST987654321"

customer_system_idstring

System Unique identifier of the Order entry within customer systems.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

statusstring

Represents order status

Example: "In Transit"

customerobject(customer_data)

support_organisationobject(customer_care_data)

cargoobject(cargo_data)

order_stagesArray of objects(order_stage_data)

Represents Order execution flows

trackingArray of objects(gps_data)

Tracking data for the order

temperaturesobject

Response

application/json

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "order_id": "ORD123456789",
  "customer_order_id": "CUST987654321",
  "customer_system_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "In Transit",
  "customer": {
    "customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "My Best Company, UAB",
    "customer_vat": "LT123456789",
    "address": { … }
  },
  "support_organisation": {
    "phone": "000000000000",
    "email": "info@girteka.eu",
    "customer_care_id": "15"
  },
  "cargo": {
    "description": "Motocyrcles",
    "weightKg": "600",
    "volumeM3": "60"
  },
  "order_stages": [
    { … }
  ],
  "tracking": [
    { … }
  ],
  "temperatures": {
    "temperature_setting": "25.5",
    "temperature_data": [ … ]
  }
}

Returns all orders as per search criteria provided in query. Search method returns only latest values.

Request

Returns all data or requested objects associated with the order. the search is performed only on the scope of the orders allowed for the api-consumer

Security

CognitoOAuth2Test(Required scopes: ) or CognitoOAuth2Prod(Required scopes: )

Query

trailer_plate_idstring

Search for the active orders with current assigned specific trailer plate id. This comes only in combination of open_orders is true.

Examples:

Valid triler id trailer_plate_id=

Forbidden access trailer_plate_id=forbidden-order

Not found trailer_plate_id=not-found-order

curl -i -X GET \
  'https://api-docs.girteka.eu/_mock/orders-api/api/orders?trailer_plate_id=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Temperature readings sorted by tampstamp

Bodyapplication/jsonArray [

idstringrequired

System Unique identifier of the Order entry. ID is created during order creation and represents Girteka systems uniq ID

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

order_idstringrequired

Girteka Internal unique identifier of the order. This is Girteka SAP ID

Example: "ORD123456789"

customer_order_idstring

Order ID provided by the Customer. In an situtation when customer does not provide customer id in order reques, this field is the same as Girteka order_id.

Example: "CUST987654321"

customer_system_idstring

System Unique identifier of the Order entry within customer systems.

Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"

statusstring

Represents order status

Example: "In Transit"

customerobject(customer_data)

support_organisationobject(customer_care_data)

cargoobject(cargo_data)

order_stagesobject(order_stage_data)

trackingobject(gps_data)

This is data set for the gps location on the order

temperaturesobject

]

Response

application/json

[
  {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "order_id": "ORD123456789",
    "customer_order_id": "CUST987654321",
    "customer_system_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "status": "In Transit",
    "customer": { … },
    "support_organisation": { … },
    "cargo": { … },
    "order_stages": { … },
    "tracking": { … },
    "temperatures": { … }
  }
]

Girteka Orders API (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude

Orders

Get all data for specific data order

Request

Responses

Was this helpful?

Get all temperature readings associated with specific order

Request

Responses

Was this helpful?

Get latest temperature readings associated with specific order

Request

Responses

Was this helpful?

This is an implementation of orders data update when order data object is provided in the body.

Request

Responses

Was this helpful?

Returns all orders as per search criteria provided in query. Search method returns only latest values.

Request

Responses

Was this helpful?

Girteka Orders API (1.0)CopyCopy for LLMCopy page as Markdown for LLMsView as MarkdownOpen this page as MarkdownOpen in ChatGPTGet insights from ChatGPTOpen in ClaudeGet insights from Claude

Orders

Get all data for specific data order

Request

Responses

Was this helpful?

Get all temperature readings associated with specific order

Request

Responses

Was this helpful?

Get latest temperature readings associated with specific order

Request

Responses

Was this helpful?

This is an implementation of orders data update when order data object is provided in the body.

Request

Responses

Was this helpful?

Returns all orders as per search criteria provided in query. Search method returns only latest values.

Request

Responses

Was this helpful?

Girteka Orders API (1.0)
Copy for LLM
Copy page as Markdown for LLMs
View as Markdown
Open this page as Markdown
Open in ChatGPT
Get insights from ChatGPT
Open in Claude
Get insights from Claude