Ana içeriğe geç
API docs by Redocly

Platin360 (0.2.0)

Download OpenAPI specification:Download

Platin360 Development Team: [email protected] Terms of Service
Documentatin Reference

Platin360 Public Api Documentation

This documentation is under active development, feedbacks, requests and questions are welcome.

product

Product Service

GetProductsByQuery

Product listing query

Authorizations:
bearerAuth
Request Body schema: application/json

Get products by query

relation
Array of arrays or null or null
Default: null
filter
object or null
Default: null
page
integer >= 0
Default: 1
limit
integer [ 25 .. 100 ]
Default: 25
search
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "relation": null,
  • "filter": null,
  • "page": 1,
  • "limit": 25,
  • "search": null
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

CreateProduct

Create product

Authorizations:
bearerAuth
Request Body schema: application/json

Create Product

currency_id
required
integer

Currency of the product

required
Array of objects non-empty

Variants of the product

Responses

Request samples

Content type
application/json
{
  • "currency_id": 1,
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "91ccf111-56c9-5a10-8bf7-4353b23b98f3",
  • "currency_id": 1,
  • "title": "API Test Product",
  • "status": "draft",
  • "created_at": "2023-02-13T10:53:53.000000Z",
  • "updated_at": "2023-02-13T10:53:53.000000Z",
  • "variants": [
    ]
}

GetProductById

Show product

Authorizations:
bearerAuth
path Parameters
id
required
integer

Product identifier

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "91ccf111-56c9-5a10-8bf7-4353b23b98f3",
  • "currency_id": 1,
  • "title": "API Test Product",
  • "status": "draft",
  • "created_at": "2023-02-13T10:53:53.000000Z",
  • "updated_at": "2023-02-13T10:53:53.000000Z",
  • "variants": [
    ]
}

UpdateProductById

Update product

Authorizations:
bearerAuth
path Parameters
id
required
integer

Product identifier

Request Body schema: application/json
id
integer

Product identifier

uuid
string

Product unique identifier

currency_id
integer

Product currency identifier

title
string

Product title

status
string
Enum: "draft" "passive" "active"

Product listing status

created_at
string

Create date of the object

updated_at
string

Update date of the object

Array of objects (ProductVariant)

Responses

Request samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "91ccf111-56c9-5a10-8bf7-4353b23b98f3",
  • "currency_id": 1,
  • "title": "API Test Product",
  • "status": "draft",
  • "created_at": "2023-02-13T10:53:53.000000Z",
  • "updated_at": "2023-02-13T10:53:53.000000Z",
  • "variants": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "uuid": "91ccf111-56c9-5a10-8bf7-4353b23b98f3",
  • "currency_id": 1,
  • "title": "API Test Product",
  • "status": "draft",
  • "created_at": "2023-02-13T10:53:53.000000Z",
  • "updated_at": "2023-02-13T10:53:53.000000Z",
  • "variants": [
    ]
}

inventory

Inventory Service

GetInventoriesByQuery

GetInventoriesByQuery definition

Authorizations:
bearerAuth
Request Body schema: application/json
page
integer >= 0
Default: 1
limit
integer [ 25 .. 100 ]
Default: 25
relation
Array of arrays or null or null
Default: null
filter
object or null
Default: null
search
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "limit": 25,
  • "relation": null,
  • "filter": null,
  • "search": null
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

UpdateBySkuOrBarcode

Using this service, you can update a variant's stock quantity by either a sku or barcode.

Authorizations:
bearerAuth
Request Body schema: application/json

Update inventory stock by sku or barcode

One of
sku
required
string

The Stock Keeping Unit of the inventory.

method
string
Default: "set"
Enum: "adjust" "set"

The update method, set will equalize the current stock to given value while adjust will append the given value to the current stock.

value
required
integer

Update value the stock will be manipulated according to.

location_id
integer
Default: null

Location identifier of the level, if not specified, default location will be used.

object (ProductVariant)

Variant Model Definition

Responses

Request samples

Content type
application/json
{
  • "barcode": "BARCODE1",
  • "method": "adjust",
  • "value": 1,
  • "location_id": null,
  • "variant": {
    }
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "adjustment": 0,
  • "inventory_level_id": 0
}

order

Order Service

GetOrdersByQuery

Order query

Authorizations:
bearerAuth
Request Body schema: application/json

GetOrdersByQuery definition

page
integer >= 0
Default: 1
limit
integer [ 25 .. 100 ]
Default: 25
relation
Array of arrays or null or null
Default: null
filter
object or null
Default: null
search
object or null
Default: null

Responses

Request samples

Content type
application/json
{
  • "page": 1,
  • "limit": 25,
  • "relation": null,
  • "filter": null,
  • "search": null
}

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "meta": {
    }
}

GetOrderById

GetOrderById definition

Authorizations:
bearerAuth
path Parameters
id
required
integer

Order identifier

Responses

Response samples

Content type
application/json
{
  • "id": 1001,
  • "uuid": "e5cd2ce2-bc62-5470-b9a3-f323c0e2dc5d",
  • "customer_id": 1,
  • "amount": 1120.5,
  • "ordered_at": "2023-02-13T10:53:53.000000Z",
  • "created_at": "2023-02-13T10:53:53.000000Z",
  • "updated_at": "2023-02-13T10:53:53.000000Z"
}