Fluximus - Api (v1)

Fluximus Developer Portal: [email protected] URL: https://fluximus.dev/ License: Developer Agreement & Policy Terms of Service

Operations for managing Channels

Channels

Channels_create

Request Body schema: application/json
required

required	object (Api) A Channel Api Object.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
url required	string <uri> The Channel's public URL.

Responses

Response Schema: application/json

required	object (Api) A Channel Api Object.
createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.
url required	string <uri> The Channel's public URL.

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string"
}
}

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Channels_delete

path Parameters

id

required

string

Responses

Response samples

default

Content type

application/json

{"type": "https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/418",
"title": "I'm a teapot",
"status": 418,
"detail": "The server refuses to brew coffee because it is, permanently, a teapot.",
"instance": "/api/v1/teapot"
}

Channels_list

Responses

Response Schema: application/json

Array

required	object (Api) A Channel Api Object.
createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.
url required	string <uri> The Channel's public URL.

Response samples

200

Content type

application/json

[{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}
]

Channels_read

path Parameters

id

required

string

Responses

Response Schema: application/json

required	object (Api) A Channel Api Object.
createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.
url required	string <uri> The Channel's public URL.

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Channels_update

path Parameters

id

required

string

Request Body schema: application/json
required

required	object (Api) A Channel Api Object.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
url required	string <uri> The Channel's public URL.

Responses

Response Schema: application/json

required	object (Api) A Channel Api Object.
createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
id required	string <uuid> The Channel Id.
name required	string A friendly name for the Channel.
organizationId required	string <uuid> The Organization this Channel belongs to.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.
url required	string <uri> The Channel's public URL.

Request samples

Payload

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string"
}
}

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"organizationId": "7bc05553-4b68-44e8-b7bc-37be63c6d9e9",
"name": "string",
"url": "http://example.com",
"api": {"type": "shift4shop",
"endpointId": "string",
"key": "string",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Get the total number of products

Responses

Response Schema: application/json

integer <int32>

Response samples

200

Content type

application/json

0

0

Products_read

Get a single Product by Id

path Parameters

id

required

string

Responses

Response Schema: application/json

createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
description required	string The Product's description.
id required	string <uuid> The Product Id.
image required	string <uri> The Product's image.
name required	string The Product's name.
price required	number The Product's price.
quantity required	number The Product's quantity.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"price": 0,
"quantity": 0,
"image": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Shift4Shop

Get the total number of products

Responses

Response Schema: application/json

integer <int32>

Response samples

200

Content type

application/json

0

0

Products_read

Get a single Product by Id

path Parameters

id

required

string

Responses

Response Schema: application/json

createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
description required	string The Product's description.
id required	string <uuid> The Product Id.
image required	string <uri> The Product's image.
name required	string The Product's name.
price required	number The Product's price.
quantity required	number The Product's quantity.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"price": 0,
"quantity": 0,
"image": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Products

Get the total number of products

Responses

Response Schema: application/json

integer <int32>

Response samples

200

Content type

application/json

0

0

Products_read

Get a single Product by Id

path Parameters

id

required

string

Responses

Response Schema: application/json

createdAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when created.
description required	string The Product's description.
id required	string <uuid> The Product Id.
image required	string <uri> The Product's image.
name required	string The Product's name.
price required	number The Product's price.
quantity required	number The Product's quantity.
updatedAt required	string <date-time> The RFC 3339 date in coordinated universal time (UTC) when last modified.

Response samples

200
default

Content type

application/json

{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"description": "string",
"price": 0,
"quantity": 0,
"image": "http://example.com",
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z"
}

Fluximus - Api (v1)

Channels

Channels_create

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Channels_delete

path Parameters

Responses

Response samples

Channels_list

Responses

Response Schema: application/json

Response samples

Channels_read

path Parameters

Responses

Response Schema: application/json

Response samples

Channels_update

path Parameters

Request Body schema: application/jsonrequired

Responses

Response Schema: application/json

Request samples

Response samples

Get the total number of products

Responses

Response Schema: application/json

Response samples

Products_read

path Parameters

Responses

Response Schema: application/json

Response samples

Shift4Shop

Get the total number of products

Responses

Response Schema: application/json

Response samples

Products_read

path Parameters

Responses

Response Schema: application/json

Response samples

Products

Get the total number of products

Responses

Response Schema: application/json

Response samples

Products_read

path Parameters

Responses

Response Schema: application/json

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required