Pos

Retrieve a specific pos object

get

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

200

The requested pos object.

application/json

404

The given resource or object was not found or does not exist.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/pos/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "name": "text",
  "slug": "text",
  "gateway": "garanti",
  "resource_url": "https://example.com",
  "three_d_resource_url": "https://example.com",
  "config": {
    "currency": "USD",
    "retries": 3
  },
  "created_date": "2025-05-22T09:33:13.744Z",
  "modified_date": "2025-05-22T09:33:13.744Z"
}

Update a specific pos.

put

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Body

The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field.

idstring · uuidOptional

Unique identifier for the POS (Point of Sale) system.

namestring · max: 64Required

Name of the POS system.

slugstring · max: 64Required

Unique slug used to identify the POS system.

gatewaystring · enum · max: 128Required

Payment gateway associated with the POS system. This field represents an enumerated value.

Possible values:

resource_urlstring · uriRequired

URL of the POS resource.

three_d_resource_urlstring · uri | nullableOptional

Optional URL for 3D secure payments via the POS system.

created_datestring · date-timeOptional

Timestamp when the POS system was created.

modified_datestring · date-timeOptional

Timestamp when the POS system was last modified.

Responses

200

The updated pos object.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

404

The given resource or object was not found or does not exist.

application/json

put

HTTPcURLJavaScriptPython

PUT /api/v1/pos/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 511

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": {
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "name": "text",
  "slug": "text",
  "gateway": "garanti",
  "resource_url": "https://example.com",
  "three_d_resource_url": "https://example.com",
  "config": {
    "currency": "USD",
    "retries": 3
  },
  "created_date": "2025-05-22T09:33:13.744Z",
  "modified_date": "2025-05-22T09:33:13.744Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "name": "text",
  "slug": "text",
  "gateway": "garanti",
  "resource_url": "https://example.com",
  "three_d_resource_url": "https://example.com",
  "config": {
    "currency": "USD",
    "retries": 3
  },
  "created_date": "2025-05-22T09:33:13.744Z",
  "modified_date": "2025-05-22T09:33:13.744Z"
}

Delete a specific pos object

delete

Authorizations

Path parameters

idintegerRequired

Unique identifier of the resource

Example: 1

Responses

204

No content

404

The given resource or object was not found or does not exist.

application/json

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/pos/{id}/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

No content

List all pos entries

get

Authorizations

Query parameters

idintegerOptional

Filters by id

channelintegerOptional

ID of the channel the customer belongs to

Example: 5

modified_datestring · date-timeOptional

Filter by modification date using supported lookup expressions (e.g., gt, gte, lt, lte, date__gt, etc.).

Example: modified_date__lt=2024-01-01T00:00:00Z

Responses

200

A list of pos entries.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/pos/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Accept: */*

200

A list of pos entries.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "channel": {
      "id": 1,
      "name": "Commerce Channel",
      "catalog": 1,
      "channel_type": "web",
      "conf": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "category_tree": "text",
      "is_active": true,
      "schema": {},
      "created_date": "2024-11-20T11:22:23.702774Z",
      "modified_date": "2024-11-20T11:22:23.702774Z"
    },
    "name": "text",
    "slug": "text",
    "gateway": "garanti",
    "resource_url": "https://example.com",
    "three_d_resource_url": "https://example.com",
    "config": {
      "currency": "USD",
      "retries": 3
    },
    "created_date": "2025-05-22T09:33:13.744Z",
    "modified_date": "2025-05-22T09:33:13.744Z"
  }
]

Create a new pos object

post

Authorizations

Body

The Pos model represents a Point of Sale system used for processing payments. It includes details such as the name, slug, payment gateway, resource URLs, and configuration settings. It is associated with a specific channel and can be integrated with external systems via the integration field.

idstring · uuidOptional

Unique identifier for the POS (Point of Sale) system.

namestring · max: 64Required

Name of the POS system.

slugstring · max: 64Required

Unique slug used to identify the POS system.

gatewaystring · enum · max: 128Required

Payment gateway associated with the POS system. This field represents an enumerated value.

Possible values:

resource_urlstring · uriRequired

URL of the POS resource.

three_d_resource_urlstring · uri | nullableOptional

Optional URL for 3D secure payments via the POS system.

created_datestring · date-timeOptional

Timestamp when the POS system was created.

modified_datestring · date-timeOptional

Timestamp when the POS system was last modified.

Responses

201

The pos was successfully created.

application/json

400

Required field(s) are missing, data is invalid, or the action is not allowed.

application/json

post

HTTPcURLJavaScriptPython

POST /api/v1/pos/ HTTP/1.1
Host: sandbox.akinon.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 511

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": {
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "name": "text",
  "slug": "text",
  "gateway": "garanti",
  "resource_url": "https://example.com",
  "three_d_resource_url": "https://example.com",
  "config": {
    "currency": "USD",
    "retries": 3
  },
  "created_date": "2025-05-22T09:33:13.744Z",
  "modified_date": "2025-05-22T09:33:13.744Z"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "channel": {
    "id": 1,
    "name": "Commerce Channel",
    "catalog": 1,
    "channel_type": "web",
    "conf": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "category_tree": "text",
    "is_active": true,
    "schema": {},
    "created_date": "2024-11-20T11:22:23.702774Z",
    "modified_date": "2024-11-20T11:22:23.702774Z"
  },
  "name": "text",
  "slug": "text",
  "gateway": "garanti",
  "resource_url": "https://example.com",
  "three_d_resource_url": "https://example.com",
  "config": {
    "currency": "USD",
    "retries": 3
  },
  "created_date": "2025-05-22T09:33:13.744Z",
  "modified_date": "2025-05-22T09:33:13.744Z"
}