Vue Play Market API (1.0.0)

Download OpenAPI specification:Download

Vue Play: support@vueplay.com URL: https://vueplay.com License: Apache 2.0

API documentation for FeathersJS service including market functionality.

Authentication

User login

Logs in a user using jwt strategy, and returns a JWT token. Auth jwt token for authentication can be obtained using user authentication service.

Request Body schema: application/json
required

strategy	string Default: "jwt" The authentication strategy to use (only jwt is available).
accessToken	string Required.

Responses

Request samples

Payload
Feathers

Content type

application/json

{"strategy": "jwt",
"accessToken": "string"
}

Response samples

201
400
401
500

Content type

application/json

{"accessToken": "string"
}

Access Scopes

Retrieve a list of Access Scopes

Returns a list of Access Scopes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('access_scopes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"name": "Full access",
"slug": "full_access",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 2,
"name": "Access scopes read",
"slug": "access_scopes_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 3,
"name": "Access scopes write",
"slug": "access_scopes_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 4,
"name": "Account access scopes read",
"slug": "account_access_scopes_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 5,
"name": "Account access scopes write",
"slug": "account_access_scopes_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 6,
"name": "Account payment providers read",
"slug": "account_payment_providers_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 7,
"name": "Account payment providers write",
"slug": "account_payment_providers_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 8,
"name": "Account users read",
"slug": "account_users_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 9,
"name": "Account users write",
"slug": "account_users_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 10,
"name": "Accounts read",
"slug": "accounts_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 11,
"name": "Accounts write",
"slug": "accounts_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 12,
"name": "Categories read",
"slug": "categories_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 13,
"name": "Categories write",
"slug": "categories_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 14,
"name": "Customer access groups read",
"slug": "customer_access_groups_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 15,
"name": "Customer access groups write",
"slug": "customer_access_groups_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 16,
"name": "Customer payment providers read",
"slug": "customer_payment_providers_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 17,
"name": "Customer payment providers write",
"slug": "customer_payment_providers_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 18,
"name": "Customer users read",
"slug": "customer_users_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 19,
"name": "Customer users write",
"slug": "customer_users_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 20,
"name": "Customers read",
"slug": "customers_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 21,
"name": "Customers write",
"slug": "customers_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 22,
"name": "Errors read",
"slug": "errors_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 23,
"name": "Errors write",
"slug": "errors_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 24,
"name": "Order history read",
"slug": "order_history_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 25,
"name": "Order history write",
"slug": "order_history_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 26,
"name": "Order lines read",
"slug": "order_lines_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 27,
"name": "Order lines write",
"slug": "order_lines_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 28,
"name": "Orders read",
"slug": "orders_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 29,
"name": "Orders write",
"slug": "orders_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 30,
"name": "Payment methods read",
"slug": "payment_methods_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 31,
"name": "Payment methods write",
"slug": "payment_methods_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 32,
"name": "Payment providers read",
"slug": "payment_providers_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 33,
"name": "Payment providers write",
"slug": "payment_providers_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 34,
"name": "Payments read",
"slug": "payments_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 35,
"name": "Payments write",
"slug": "payments_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 36,
"name": "Plans read",
"slug": "plans_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 37,
"name": "Plans write",
"slug": "plans_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 38,
"name": "Product media read",
"slug": "product_media_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 39,
"name": "Product media write",
"slug": "product_media_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 42,
"name": "Products read",
"slug": "products_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 43,
"name": "Products write",
"slug": "products_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 44,
"name": "Reviews read",
"slug": "reviews_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 45,
"name": "Reviews write",
"slug": "reviews_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 46,
"name": "Role access read",
"slug": "role_access_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 47,
"name": "Role access write",
"slug": "role_access_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 48,
"name": "Roles read",
"slug": "roles_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 49,
"name": "Roles write",
"slug": "roles_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 50,
"name": "Services read",
"slug": "services_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 51,
"name": "Services write",
"slug": "services_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 52,
"name": "Tags create",
"slug": "tags_create",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 53,
"name": "Tags read",
"slug": "tags_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 54,
"name": "Tags write",
"slug": "tags_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 55,
"name": "Role access scopes read",
"slug": "role_access_scopes_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 56,
"name": "Role access scopes write",
"slug": "role_access_scopes_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 57,
"name": "Tax codes read",
"slug": "tax_codes_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 58,
"name": "Tax codes write",
"slug": "tax_codes_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 59,
"name": "Tiers read",
"slug": "tiers_read",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
},
{"id": 60,
"name": "Tiers write",
"slug": "tiers_write",
"description": "",
"created_at": "2024-08-19T12:34:56Z",
"updated_at": "2024-08-20T12:34:56Z"
}
]
}

Create a new access scope

Creates a new access scope based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Access scope object that needs to be added

name	string
slug required	string
description	string

Responses

Request samples

Payload
Feathers

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an access scope by ID

Retrieves an access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('access_scopes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an access scope by ID

Updates an access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Access scope object that needs to be updated

name	string
slug required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an access scope by ID

Patches an access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Access scope object that needs to be updated

name	string
slug required	string
description	string

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an access scope by ID

Deletes an access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Accounts

Retrieve a list of Accounts

Returns a list of Accounts.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('accounts').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new account

Creates a new account based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Account object that needs to be added

country required	string
first_name	string
middle_name	string
last_name	string
email required	string <email>
phone	string
slug required	string
business_country	string
business_state	string
business_street	string
business_city	string
business_zip	string
notes	string
business_type	string Enum: "company" "government_entity" "individual" "non_profit"
status	string Enum: "active" "inactive" "banned"
currency	string
platform_percentage_fee	integer
individual_dob	string <date>
individual_id_number	string
individual_ssn_last_4	string <= 4 characters
individual_political_exposure	boolean
company_name	string
company_tax_id	string
company_vat_id	string
company_registration_number	string

Responses

Request samples

Payload
Feathers

Content type

application/json

{"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an account by ID

Retrieves an account based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('accounts').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an account by ID

Updates an account based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Account object that needs to be updated

country required	string
first_name	string
middle_name	string
last_name	string
email required	string <email>
phone	string
slug required	string
business_country	string
business_state	string
business_street	string
business_city	string
business_zip	string
notes	string
business_type	string Enum: "company" "government_entity" "individual" "non_profit"
status	string Enum: "active" "inactive" "banned"
currency	string
platform_percentage_fee	integer
individual_dob	string <date>
individual_id_number	string
individual_ssn_last_4	string <= 4 characters
individual_political_exposure	boolean
company_name	string
company_tax_id	string
company_vat_id	string
company_registration_number	string

Responses

Request samples

Payload

Content type

application/json

{"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an account by ID

Patches an account based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Account object that needs to be updated

country required	string
first_name	string
middle_name	string
last_name	string
email required	string <email>
phone	string
slug required	string
business_country	string
business_state	string
business_street	string
business_city	string
business_zip	string
notes	string
business_type	string Enum: "company" "government_entity" "individual" "non_profit"
status	string Enum: "active" "inactive" "banned"
currency	string
platform_percentage_fee	integer
individual_dob	string <date>
individual_id_number	string
individual_ssn_last_4	string <= 4 characters
individual_political_exposure	boolean
company_name	string
company_tax_id	string
company_vat_id	string
company_registration_number	string

Responses

Request samples

Payload

Content type

application/json

{"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"country": "string",
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "user@example.com",
"phone": "string",
"slug": "string",
"business_country": "string",
"business_state": "string",
"business_street": "string",
"business_city": "string",
"business_zip": "string",
"notes": "string",
"business_type": "company",
"status": "active",
"currency": "string",
"platform_percentage_fee": 0,
"individual_dob": "2019-08-24",
"individual_id_number": "string",
"individual_ssn_last_4": "stri",
"individual_political_exposure": true,
"company_name": "string",
"company_tax_id": "string",
"company_vat_id": "string",
"company_registration_number": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an account by ID

Deletes an account based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

AccountUsers

Retrieve a list of AccountUsers

Returns a list of AccountUsers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('account_users').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"account_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new account user

Creates a new account user based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

AccountUser object that needs to be added

account_id required	integer The ID of the associated account.
user_id required	integer The ID of the associated user.

Responses

Request samples

Payload
Feathers

Content type

application/json

{"account_id": 0,
"user_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"account_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an account user by ID

Retrieves an account user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('account_users').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an account user by ID

Updates an account user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AccountUser object that needs to be updated

account_id required	integer The ID of the associated account.
user_id required	integer The ID of the associated user.

Responses

Request samples

Payload

Content type

application/json

{"account_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an account user by ID

Patches an account user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AccountUser object that needs to be updated

account_id required	integer The ID of the associated account.
user_id required	integer The ID of the associated user.

Responses

Request samples

Payload

Content type

application/json

{"account_id": 0,
"user_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"account_id": 0,
"user_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an account user by ID

Deletes an account user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Customers

Retrieve a list of Customers

Returns a list of Customers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('customers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new customer

Creates a new customer based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Customer object that needs to be added

first_name	string
middle_name	string
last_name	string
email	string
phone	string
billing_country	string
billing_state	string
billing_street	string
billing_city	string
billing_zip	string
shipping_country	string
shipping_state	string
shipping_street	string
shipping_city	string
shipping_zip	string
notes	string <= 1200 characters
status	string Default: "active" Enum: "active" "inactive" "banned"
currency required	string Default: "USD"

Responses

Request samples

Payload
Feathers

Content type

application/json

{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an customer by ID

Retrieves an customer based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('customers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an customer by ID

Updates an customer based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Customer object that needs to be updated

first_name	string
middle_name	string
last_name	string
email	string
phone	string
billing_country	string
billing_state	string
billing_street	string
billing_city	string
billing_zip	string
shipping_country	string
shipping_state	string
shipping_street	string
shipping_city	string
shipping_zip	string
notes	string <= 1200 characters
status	string Default: "active" Enum: "active" "inactive" "banned"
currency required	string Default: "USD"

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an customer by ID

Patches an customer based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Customer object that needs to be updated

first_name	string
middle_name	string
last_name	string
email	string
phone	string
billing_country	string
billing_state	string
billing_street	string
billing_city	string
billing_zip	string
shipping_country	string
shipping_state	string
shipping_street	string
shipping_city	string
shipping_zip	string
notes	string <= 1200 characters
status	string Default: "active" Enum: "active" "inactive" "banned"
currency required	string Default: "USD"

Responses

Request samples

Payload

Content type

application/json

{"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"first_name": "string",
"middle_name": "string",
"last_name": "string",
"email": "string",
"phone": "string",
"billing_country": "string",
"billing_state": "string",
"billing_street": "string",
"billing_city": "string",
"billing_zip": "string",
"shipping_country": "string",
"shipping_state": "string",
"shipping_street": "string",
"shipping_city": "string",
"shipping_zip": "string",
"notes": "string",
"status": "active",
"currency": "USD",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an customer by ID

Deletes an customer based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

CustomerUsers

Retrieve a list of CustomerUsers

Returns a list of CustomerUsers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('customer_users').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new customer user

Creates a new customer user based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

CustomerUser object that needs to be added

id	integer Unique identifier for the customer-user relationship
customer_id required	integer ID of the associated customer
user_id required	integer ID of the associated user
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an customer user by ID

Retrieves an customer user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('customer_users').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an customer user by ID

Updates an customer user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerUser object that needs to be updated

id	integer Unique identifier for the customer-user relationship
customer_id required	integer ID of the associated customer
user_id required	integer ID of the associated user
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an customer user by ID

Patches an customer user based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerUser object that needs to be updated

id	integer Unique identifier for the customer-user relationship
customer_id required	integer ID of the associated customer
user_id required	integer ID of the associated user
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"user_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an customer user by ID

Deletes an customer user based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

CustomerAccessGroups

Retrieve a list of CustomerAccessGroups

Returns a list of CustomerAccessGroups.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('customer_access_groups').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new customer access group

Creates a new customer access group based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

CustomerAccessGroup object that needs to be added

id	integer Unique identifier for the customer-access group relationship
customer_id required	integer ID of the associated customer
access_group_id required	integer ID of the associated access group
users_count required	integer Number of users associated with the access group
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an customer access group by ID

Retrieves an customer access group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('customer_access_groups').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an customer access group by ID

Updates an customer access group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerAccessGroup object that needs to be updated

id	integer Unique identifier for the customer-access group relationship
customer_id required	integer ID of the associated customer
access_group_id required	integer ID of the associated access group
users_count required	integer Number of users associated with the access group
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an customer access group by ID

Patches an customer access group based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerAccessGroup object that needs to be updated

id	integer Unique identifier for the customer-access group relationship
customer_id required	integer ID of the associated customer
access_group_id required	integer ID of the associated access group
users_count required	integer Number of users associated with the access group
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 42,
"access_group_id": 5,
"users_count": 10,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an customer access group by ID

Deletes an customer access group based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

PaymentProviders

Retrieve a list of PaymentProviders

Returns a list of PaymentProviders.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('payment_providers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new payment provider

Creates a new payment provider based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

PaymentProvider object that needs to be added

id	integer Unique identifier for the payment provider
title	string Title of the payment provider
slug required	string Unique slug identifier for the payment provider
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an payment provider by ID

Retrieves an payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('payment_providers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an payment provider by ID

Updates an payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

PaymentProvider object that needs to be updated

id	integer Unique identifier for the payment provider
title	string Title of the payment provider
slug required	string Unique slug identifier for the payment provider
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an payment provider by ID

Patches an payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

PaymentProvider object that needs to be updated

id	integer Unique identifier for the payment provider
title	string Title of the payment provider
slug required	string Unique slug identifier for the payment provider
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Stripe",
"slug": "stripe",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an payment provider by ID

Deletes an payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a list of Categories

Returns a list of Categories.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('categories').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new category

Creates a new category based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Category object that needs to be added

id	integer Unique identifier for the category
parent_id	integer ID of the parent category if applicable
title required	string Title of the category
slug required	string Unique slug identifier for the category
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an category by ID

Retrieves an category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('categories').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an category by ID

Updates an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

id	integer Unique identifier for the category
parent_id	integer ID of the parent category if applicable
title required	string Title of the category
slug required	string Unique slug identifier for the category
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an category by ID

Patches an category based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Category object that needs to be updated

id	integer Unique identifier for the category
parent_id	integer ID of the parent category if applicable
title required	string Title of the category
slug required	string Unique slug identifier for the category
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 2,
"title": "Electronics",
"slug": "electronics",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an category by ID

Deletes an category based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve a list of Tags

Returns a list of Tags.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('tags').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new tag

Creates a new tag based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Tag object that needs to be added

id	integer Unique identifier for the tag
title required	string Title of the tag
slug required	string Unique slug identifier for the tag
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an tag by ID

Retrieves an tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('tags').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an tag by ID

Updates an tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tag object that needs to be updated

id	integer Unique identifier for the tag
title required	string Title of the tag
slug required	string Unique slug identifier for the tag
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an tag by ID

Patches an tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tag object that needs to be updated

id	integer Unique identifier for the tag
title required	string Title of the tag
slug required	string Unique slug identifier for the tag
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"title": "Technology",
"slug": "technology",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an tag by ID

Deletes an tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ShippingClasses

Retrieve a list of ShippingClasses

Returns a list of ShippingClasses.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('shipping_classes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new shipping class

Creates a new shipping class based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ShippingClass object that needs to be added

id	integer Unique identifier for the shipping class
name required	string Name of the shipping class
description	string Description of the shipping class
base_rate required	integer Base rate in minor units (e.g., cents)
rate_per_kg	integer Rate per kilogram in minor units (e.g., cents)
free_shipping_threshold	integer Amount required to qualify for free shipping in minor units (e.g., cents)
min_weight	integer Minimum weight allowed for this shipping class
max_weight	integer Maximum weight allowed for this shipping class
max_width	integer Maximum width allowed for this shipping class in mm
max_height	integer Maximum height allowed for this shipping class in mm
max_length	integer Maximum length allowed for this shipping class in mm
allowed_countries	Array of strings List of country codes where this class is allowed
disallowed_countries	Array of strings List of country codes where this class is disallowed
handling_fee	integer Extra handling fee for this class in minor units (e.g., cents)
handling_fee_currency	string Currency of the extra handling fee
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an shipping class by ID

Retrieves an shipping class based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('shipping_classes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an shipping class by ID

Updates an shipping class based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ShippingClass object that needs to be updated

id	integer Unique identifier for the shipping class
name required	string Name of the shipping class
description	string Description of the shipping class
base_rate required	integer Base rate in minor units (e.g., cents)
rate_per_kg	integer Rate per kilogram in minor units (e.g., cents)
free_shipping_threshold	integer Amount required to qualify for free shipping in minor units (e.g., cents)
min_weight	integer Minimum weight allowed for this shipping class
max_weight	integer Maximum weight allowed for this shipping class
max_width	integer Maximum width allowed for this shipping class in mm
max_height	integer Maximum height allowed for this shipping class in mm
max_length	integer Maximum length allowed for this shipping class in mm
allowed_countries	Array of strings List of country codes where this class is allowed
disallowed_countries	Array of strings List of country codes where this class is disallowed
handling_fee	integer Extra handling fee for this class in minor units (e.g., cents)
handling_fee_currency	string Currency of the extra handling fee
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an shipping class by ID

Patches an shipping class based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ShippingClass object that needs to be updated

id	integer Unique identifier for the shipping class
name required	string Name of the shipping class
description	string Description of the shipping class
base_rate required	integer Base rate in minor units (e.g., cents)
rate_per_kg	integer Rate per kilogram in minor units (e.g., cents)
free_shipping_threshold	integer Amount required to qualify for free shipping in minor units (e.g., cents)
min_weight	integer Minimum weight allowed for this shipping class
max_weight	integer Maximum weight allowed for this shipping class
max_width	integer Maximum width allowed for this shipping class in mm
max_height	integer Maximum height allowed for this shipping class in mm
max_length	integer Maximum length allowed for this shipping class in mm
allowed_countries	Array of strings List of country codes where this class is allowed
disallowed_countries	Array of strings List of country codes where this class is disallowed
handling_fee	integer Extra handling fee for this class in minor units (e.g., cents)
handling_fee_currency	string Currency of the extra handling fee
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Standard Shipping",
"description": "Standard shipping for domestic orders.",
"base_rate": 500,
"rate_per_kg": 200,
"free_shipping_threshold": 2000,
"min_weight": 0,
"max_weight": 50000,
"max_width": 1200,
"max_height": 1500,
"max_length": 1500,
"allowed_countries": ["US",
"CA",
"MX"
],
"disallowed_countries": ["CN",
"IN"
],
"handling_fee": 150,
"handling_fee_currency": "USD",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an shipping class by ID

Deletes an shipping class based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Products

Retrieve a list of Products

Returns a list of Products.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('products').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new product

Creates a new product based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Product object that needs to be added

id	integer Unique identifier for the product
name required	string Name of the product
description	string Product description
category_id	integer ID of the category to which the product belongs
sku required	string Stock Keeping Unit (SKU) for the product
slug required	string URL-friendly version of the product name
image_url	string URL to the product's image
price required	integer Price of the product in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the product
currency required	string Currency code for the price (e.g., USD)
discount_price	integer Discounted price in minor units (e.g., cents)
tax_code required	string Tax code for the product
tax_rate	integer Tax rate applied to the product in percentage
vat_included	boolean Whether VAT is included in the price
stock_quantity	integer Available stock quantity
in_stock	boolean Whether the product is in stock
min_order_quantity	integer Minimum order quantity for the product
max_order_quantity	integer Maximum order quantity for the product
is_digital	boolean Whether the product is a digital product
width	integer Width of the product in millimeters
height	integer Height of the product in millimeters
length	integer Length of the product in millimeters
weight	integer Weight of the product in grams
shipping_class_id	integer ID of the shipping class the product belongs to
free_shipping	boolean Whether the product qualifies for free shipping
	object Dynamic product attributes such as color, size, etc.
available_from	string <date-time> Date from which the product is available
available_until	string <date-time> Date until which the product is available
status required	string Enum: "active" "inactive" "archived" The status of the product
is_featured	boolean Whether the product is featured
average_rating	number <float> Average customer rating for the product (out of 5)
account_id	integer ID of the vendor's account
vendor	string Vendor name
manufacturer	string Manufacturer of the product
meta_title	string SEO meta title for the product
meta_description	string SEO meta description for the product
notes	string Additional notes about the product
created_at	string <date-time> Timestamp when the product was created
updated_at	string <date-time> Timestamp when the product was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an product by ID

Retrieves an product based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('products').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an product by ID

Updates an product based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Product object that needs to be updated

id	integer Unique identifier for the product
name required	string Name of the product
description	string Product description
category_id	integer ID of the category to which the product belongs
sku required	string Stock Keeping Unit (SKU) for the product
slug required	string URL-friendly version of the product name
image_url	string URL to the product's image
price required	integer Price of the product in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the product
currency required	string Currency code for the price (e.g., USD)
discount_price	integer Discounted price in minor units (e.g., cents)
tax_code required	string Tax code for the product
tax_rate	integer Tax rate applied to the product in percentage
vat_included	boolean Whether VAT is included in the price
stock_quantity	integer Available stock quantity
in_stock	boolean Whether the product is in stock
min_order_quantity	integer Minimum order quantity for the product
max_order_quantity	integer Maximum order quantity for the product
is_digital	boolean Whether the product is a digital product
width	integer Width of the product in millimeters
height	integer Height of the product in millimeters
length	integer Length of the product in millimeters
weight	integer Weight of the product in grams
shipping_class_id	integer ID of the shipping class the product belongs to
free_shipping	boolean Whether the product qualifies for free shipping
	object Dynamic product attributes such as color, size, etc.
available_from	string <date-time> Date from which the product is available
available_until	string <date-time> Date until which the product is available
status required	string Enum: "active" "inactive" "archived" The status of the product
is_featured	boolean Whether the product is featured
average_rating	number <float> Average customer rating for the product (out of 5)
account_id	integer ID of the vendor's account
vendor	string Vendor name
manufacturer	string Manufacturer of the product
meta_title	string SEO meta title for the product
meta_description	string SEO meta description for the product
notes	string Additional notes about the product
created_at	string <date-time> Timestamp when the product was created
updated_at	string <date-time> Timestamp when the product was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an product by ID

Patches an product based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Product object that needs to be updated

id	integer Unique identifier for the product
name required	string Name of the product
description	string Product description
category_id	integer ID of the category to which the product belongs
sku required	string Stock Keeping Unit (SKU) for the product
slug required	string URL-friendly version of the product name
image_url	string URL to the product's image
price required	integer Price of the product in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the product
currency required	string Currency code for the price (e.g., USD)
discount_price	integer Discounted price in minor units (e.g., cents)
tax_code required	string Tax code for the product
tax_rate	integer Tax rate applied to the product in percentage
vat_included	boolean Whether VAT is included in the price
stock_quantity	integer Available stock quantity
in_stock	boolean Whether the product is in stock
min_order_quantity	integer Minimum order quantity for the product
max_order_quantity	integer Maximum order quantity for the product
is_digital	boolean Whether the product is a digital product
width	integer Width of the product in millimeters
height	integer Height of the product in millimeters
length	integer Length of the product in millimeters
weight	integer Weight of the product in grams
shipping_class_id	integer ID of the shipping class the product belongs to
free_shipping	boolean Whether the product qualifies for free shipping
	object Dynamic product attributes such as color, size, etc.
available_from	string <date-time> Date from which the product is available
available_until	string <date-time> Date until which the product is available
status required	string Enum: "active" "inactive" "archived" The status of the product
is_featured	boolean Whether the product is featured
average_rating	number <float> Average customer rating for the product (out of 5)
account_id	integer ID of the vendor's account
vendor	string Vendor name
manufacturer	string Manufacturer of the product
meta_title	string SEO meta title for the product
meta_description	string SEO meta description for the product
notes	string Additional notes about the product
created_at	string <date-time> Timestamp when the product was created
updated_at	string <date-time> Timestamp when the product was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Wireless Headphones",
"description": "High-quality wireless headphones with noise cancellation.",
"category_id": 2,
"sku": "WH12345",
"slug": "wireless-headphones",
"image_url": "https://example.com/images/headphones.jpg",
"price": 2999,
"application_fee_percent": 5,
"currency": "USD",
"discount_price": 2499,
"tax_code": "TAX123",
"tax_rate": 10,
"vat_included": false,
"stock_quantity": 100,
"in_stock": true,
"min_order_quantity": 1,
"max_order_quantity": 10,
"is_digital": false,
"width": 150,
"height": 100,
"length": 200,
"weight": 350,
"shipping_class_id": 1,
"free_shipping": true,
"attributes": {"color": "black",
"size": "medium"
},
"available_from": "2024-11-01T00:00:00Z",
"available_until": "2024-12-01T00:00:00Z",
"status": "active",
"is_featured": true,
"average_rating": 4.5,
"account_id": 3,
"vendor": "BrandX",
"manufacturer": "BrandX Inc.",
"meta_title": "Wireless Headphones - Best Quality",
"meta_description": "High-quality wireless headphones with noise-cancellation, great for travel.",
"notes": "Batteries included.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an product by ID

Deletes an product based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Services

Retrieve a list of Services

Returns a list of Services.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('services').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new service

Creates a new service based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Service object that needs to be added

id	integer Unique identifier for the service
name required	string Name of the service
description	string Detailed description of the service
category_id	integer ID of the category to which the service belongs
base_price required	integer Base price for the service in minor units (e.g., cents)
discount_price	integer Discounted price for the service in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the service
tax_code required	string Tax code for the service
tax_rate	integer Tax rate for the service in percentage
pricing_model required	string Enum: "fixed" "hourly" "project-based" The pricing model for the service
vat_included	boolean Whether VAT is included in the price
duration	integer Expected duration of the service in minutes or hours
	object Availability of the service (e.g., days, hours)
location_type	string Enum: "online" "onsite" "customer_location" The type of location where the service is provided
	object Location data if applicable for onsite or customer location
extra_charge	integer Additional fees or charges for the service
currency	string Currency used for billing (e.g., USD)
account_id	integer ID of the vendor's account providing the service
vendor	string Vendor name
average_rating	number <float> Average customer rating for the service (out of 5)
notes	string Additional notes about the service
status required	string Enum: "active" "inactive" "archived" The status of the service
created_at	string <date-time> Timestamp when the service was created
updated_at	string <date-time> Timestamp when the service was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an service by ID

Retrieves an service based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('services').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an service by ID

Updates an service based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Service object that needs to be updated

id	integer Unique identifier for the service
name required	string Name of the service
description	string Detailed description of the service
category_id	integer ID of the category to which the service belongs
base_price required	integer Base price for the service in minor units (e.g., cents)
discount_price	integer Discounted price for the service in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the service
tax_code required	string Tax code for the service
tax_rate	integer Tax rate for the service in percentage
pricing_model required	string Enum: "fixed" "hourly" "project-based" The pricing model for the service
vat_included	boolean Whether VAT is included in the price
duration	integer Expected duration of the service in minutes or hours
	object Availability of the service (e.g., days, hours)
location_type	string Enum: "online" "onsite" "customer_location" The type of location where the service is provided
	object Location data if applicable for onsite or customer location
extra_charge	integer Additional fees or charges for the service
currency	string Currency used for billing (e.g., USD)
account_id	integer ID of the vendor's account providing the service
vendor	string Vendor name
average_rating	number <float> Average customer rating for the service (out of 5)
notes	string Additional notes about the service
status required	string Enum: "active" "inactive" "archived" The status of the service
created_at	string <date-time> Timestamp when the service was created
updated_at	string <date-time> Timestamp when the service was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an service by ID

Patches an service based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Service object that needs to be updated

id	integer Unique identifier for the service
name required	string Name of the service
description	string Detailed description of the service
category_id	integer ID of the category to which the service belongs
base_price required	integer Base price for the service in minor units (e.g., cents)
discount_price	integer Discounted price for the service in minor units (e.g., cents)
application_fee_percent	integer Application fee percentage for the service
tax_code required	string Tax code for the service
tax_rate	integer Tax rate for the service in percentage
pricing_model required	string Enum: "fixed" "hourly" "project-based" The pricing model for the service
vat_included	boolean Whether VAT is included in the price
duration	integer Expected duration of the service in minutes or hours
	object Availability of the service (e.g., days, hours)
location_type	string Enum: "online" "onsite" "customer_location" The type of location where the service is provided
	object Location data if applicable for onsite or customer location
extra_charge	integer Additional fees or charges for the service
currency	string Currency used for billing (e.g., USD)
account_id	integer ID of the vendor's account providing the service
vendor	string Vendor name
average_rating	number <float> Average customer rating for the service (out of 5)
notes	string Additional notes about the service
status required	string Enum: "active" "inactive" "archived" The status of the service
created_at	string <date-time> Timestamp when the service was created
updated_at	string <date-time> Timestamp when the service was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Web Development",
"description": "Complete website development, from design to deployment.",
"category_id": 3,
"base_price": 15000,
"discount_price": 12000,
"application_fee_percent": 10,
"tax_code": "TAX456",
"tax_rate": 15,
"pricing_model": "hourly",
"vat_included": false,
"duration": 120,
"availability": {"Monday": "9-5",
"Tuesday": "9-5"
},
"location_type": "online",
"service_location": {"address": "123 Main St, City",
"zipcode": "12345"
},
"extra_charge": 500,
"currency": "USD",
"account_id": 2,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Customizable packages available.",
"status": "active",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an service by ID

Deletes an service based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Plans

Retrieve a list of Plans

Returns a list of Plans.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('plans').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new plan

Creates a new plan based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Plan object that needs to be added

id	integer Unique identifier for the subscription plan
name required	string Name of the subscription plan
description	string Description of the plan's benefits
category_id	integer ID of the category to which the plan belongs (nullable)
slug	string Unique URL slug for the plan
tax_code required	string Tax code for the plan
tax_rate	integer Tax rate for the plan (optional)
currency required	string Currency used for billing (e.g., USD)
vat_included	boolean Whether VAT is included in the price
account_id	integer ID of the vendor's account offering the plan
vendor	string Vendor name for the plan
average_rating	number <float> Average rating of the plan (out of 5)
notes	string Additional notes about the plan
created_at	string <date-time> Timestamp when the plan was created
updated_at	string <date-time> Timestamp when the plan was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an plan by ID

Retrieves an plan based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('plans').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an plan by ID

Updates an plan based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Plan object that needs to be updated

id	integer Unique identifier for the subscription plan
name required	string Name of the subscription plan
description	string Description of the plan's benefits
category_id	integer ID of the category to which the plan belongs (nullable)
slug	string Unique URL slug for the plan
tax_code required	string Tax code for the plan
tax_rate	integer Tax rate for the plan (optional)
currency required	string Currency used for billing (e.g., USD)
vat_included	boolean Whether VAT is included in the price
account_id	integer ID of the vendor's account offering the plan
vendor	string Vendor name for the plan
average_rating	number <float> Average rating of the plan (out of 5)
notes	string Additional notes about the plan
created_at	string <date-time> Timestamp when the plan was created
updated_at	string <date-time> Timestamp when the plan was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an plan by ID

Patches an plan based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Plan object that needs to be updated

id	integer Unique identifier for the subscription plan
name required	string Name of the subscription plan
description	string Description of the plan's benefits
category_id	integer ID of the category to which the plan belongs (nullable)
slug	string Unique URL slug for the plan
tax_code required	string Tax code for the plan
tax_rate	integer Tax rate for the plan (optional)
currency required	string Currency used for billing (e.g., USD)
vat_included	boolean Whether VAT is included in the price
account_id	integer ID of the vendor's account offering the plan
vendor	string Vendor name for the plan
average_rating	number <float> Average rating of the plan (out of 5)
notes	string Additional notes about the plan
created_at	string <date-time> Timestamp when the plan was created
updated_at	string <date-time> Timestamp when the plan was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"name": "Premium Plan",
"description": "Access to all premium features and priority support.",
"category_id": 2,
"slug": "premium-plan",
"tax_code": "TAX123",
"tax_rate": 15,
"currency": "USD",
"vat_included": false,
"account_id": 5,
"vendor": "CompanyX",
"average_rating": 4.5,
"notes": "Discounts available for long-term subscriptions.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an plan by ID

Deletes an plan based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Tiers

Retrieve a list of Tiers

Returns a list of Tiers.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('tiers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new tier

Creates a new tier based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Tier object that needs to be added

id	integer Unique identifier for the tier
plan_id required	integer ID of the associated subscription plan
name required	string Name of the subscription plan tier
description	string Detailed description of the benefits of the tier
slug	string Unique URL slug for the tier
amount required	integer Amount for the tier in minor units (e.g., cents)
interval	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency for the plan
interval_count	integer Interval count (e.g., 1 for monthly, 12 for yearly)
trial_period_days	integer Number of trial days available for the plan
application_fee_percent	integer Application fee percentage for the tier
discount_price	integer Optional discounted price for the tier
usage_limit	integer Limit on usage for the tier
usage_max_rollover	integer Maximum allowed rollover usage count from the last period
notes	string Additional notes about the tier
created_at	string <date-time> Timestamp when the tier was created
updated_at	string <date-time> Timestamp when the tier was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an tier by ID

Retrieves an tier based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('tiers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an tier by ID

Updates an tier based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tier object that needs to be updated

id	integer Unique identifier for the tier
plan_id required	integer ID of the associated subscription plan
name required	string Name of the subscription plan tier
description	string Detailed description of the benefits of the tier
slug	string Unique URL slug for the tier
amount required	integer Amount for the tier in minor units (e.g., cents)
interval	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency for the plan
interval_count	integer Interval count (e.g., 1 for monthly, 12 for yearly)
trial_period_days	integer Number of trial days available for the plan
application_fee_percent	integer Application fee percentage for the tier
discount_price	integer Optional discounted price for the tier
usage_limit	integer Limit on usage for the tier
usage_max_rollover	integer Maximum allowed rollover usage count from the last period
notes	string Additional notes about the tier
created_at	string <date-time> Timestamp when the tier was created
updated_at	string <date-time> Timestamp when the tier was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an tier by ID

Patches an tier based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Tier object that needs to be updated

id	integer Unique identifier for the tier
plan_id required	integer ID of the associated subscription plan
name required	string Name of the subscription plan tier
description	string Detailed description of the benefits of the tier
slug	string Unique URL slug for the tier
amount required	integer Amount for the tier in minor units (e.g., cents)
interval	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency for the plan
interval_count	integer Interval count (e.g., 1 for monthly, 12 for yearly)
trial_period_days	integer Number of trial days available for the plan
application_fee_percent	integer Application fee percentage for the tier
discount_price	integer Optional discounted price for the tier
usage_limit	integer Limit on usage for the tier
usage_max_rollover	integer Maximum allowed rollover usage count from the last period
notes	string Additional notes about the tier
created_at	string <date-time> Timestamp when the tier was created
updated_at	string <date-time> Timestamp when the tier was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"plan_id": 2,
"name": "Basic Tier",
"description": "Basic features with limited usage.",
"slug": "basic-tier",
"amount": 1999,
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 14,
"application_fee_percent": 5,
"discount_price": 1499,
"usage_limit": 100,
"usage_max_rollover": 200,
"notes": "Includes limited support.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an tier by ID

Deletes an tier based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Subscriptions

Retrieve a list of Subscriptions

Returns a list of Subscriptions.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('subscriptions').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new subscription

Creates a new subscription based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Subscription object that needs to be added

id	integer Unique identifier for the subscription
customer_id required	integer ID of the associated customer
plan_id required	integer ID of the associated subscription plan
tier_id	integer ID of the associated tier
payment_provider_id required	integer ID of the associated payment provider
agreement_id	string Payment agreement identifier, if applicable
status required	string Enum: "pending" "aborted" "trial" "active" "cancelled" "paused" "expired" "stopped" Current status of the subscription
interval required	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency
interval_count	integer Number of intervals between billing cycles
trial_period_days	integer Number of trial days, if applicable
trial_started_at	string <date-time> Date when the trial period started
anchor_at	string <date-time> Date when the billing cycle begins
started_at	string <date-time> Date when the subscription started
ended_at	string <date-time> Date when the subscription ended
last_billed_at	string <date-time> Date when the last payment was processed
last_due_at	string <date-time> Date when the last payment is due
discount_price	integer Discounted price for the subscription
currency required	string Currency used for billing
usage_count	integer Count of usage for the subscription
cancellation_reason	string Reason for cancellation if applicable
notes	string Additional notes related to the subscription
created_at	string <date-time> Timestamp when the subscription was created
updated_at	string <date-time> Timestamp when the subscription was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an subscription by ID

Retrieves an subscription based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('subscriptions').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an subscription by ID

Updates an subscription based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Subscription object that needs to be updated

id	integer Unique identifier for the subscription
customer_id required	integer ID of the associated customer
plan_id required	integer ID of the associated subscription plan
tier_id	integer ID of the associated tier
payment_provider_id required	integer ID of the associated payment provider
agreement_id	string Payment agreement identifier, if applicable
status required	string Enum: "pending" "aborted" "trial" "active" "cancelled" "paused" "expired" "stopped" Current status of the subscription
interval required	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency
interval_count	integer Number of intervals between billing cycles
trial_period_days	integer Number of trial days, if applicable
trial_started_at	string <date-time> Date when the trial period started
anchor_at	string <date-time> Date when the billing cycle begins
started_at	string <date-time> Date when the subscription started
ended_at	string <date-time> Date when the subscription ended
last_billed_at	string <date-time> Date when the last payment was processed
last_due_at	string <date-time> Date when the last payment is due
discount_price	integer Discounted price for the subscription
currency required	string Currency used for billing
usage_count	integer Count of usage for the subscription
cancellation_reason	string Reason for cancellation if applicable
notes	string Additional notes related to the subscription
created_at	string <date-time> Timestamp when the subscription was created
updated_at	string <date-time> Timestamp when the subscription was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an subscription by ID

Patches an subscription based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Subscription object that needs to be updated

id	integer Unique identifier for the subscription
customer_id required	integer ID of the associated customer
plan_id required	integer ID of the associated subscription plan
tier_id	integer ID of the associated tier
payment_provider_id required	integer ID of the associated payment provider
agreement_id	string Payment agreement identifier, if applicable
status required	string Enum: "pending" "aborted" "trial" "active" "cancelled" "paused" "expired" "stopped" Current status of the subscription
interval required	string Enum: "daily" "weekly" "monthly" "yearly" Billing frequency
interval_count	integer Number of intervals between billing cycles
trial_period_days	integer Number of trial days, if applicable
trial_started_at	string <date-time> Date when the trial period started
anchor_at	string <date-time> Date when the billing cycle begins
started_at	string <date-time> Date when the subscription started
ended_at	string <date-time> Date when the subscription ended
last_billed_at	string <date-time> Date when the last payment was processed
last_due_at	string <date-time> Date when the last payment is due
discount_price	integer Discounted price for the subscription
currency required	string Currency used for billing
usage_count	integer Count of usage for the subscription
cancellation_reason	string Reason for cancellation if applicable
notes	string Additional notes related to the subscription
created_at	string <date-time> Timestamp when the subscription was created
updated_at	string <date-time> Timestamp when the subscription was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"plan_id": 2,
"tier_id": 3,
"payment_provider_id": 1,
"agreement_id": "agreement123",
"status": "active",
"interval": "monthly",
"interval_count": 1,
"trial_period_days": 30,
"trial_started_at": "2024-11-16T00:00:00Z",
"anchor_at": "2024-11-16T00:00:00Z",
"started_at": "2024-11-16T00:00:00Z",
"ended_at": "2025-11-16T00:00:00Z",
"last_billed_at": "2024-11-16T00:00:00Z",
"last_due_at": "2024-12-16T00:00:00Z",
"discount_price": 1500,
"currency": "USD",
"usage_count": 100,
"cancellation_reason": "Customer no longer needs the service.",
"notes": "Customer upgraded to a higher plan.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an subscription by ID

Deletes an subscription based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

PaymentMethods

Retrieve a list of PaymentMethods

Returns a list of PaymentMethods.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('payment_methods').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new payment method

Creates a new payment method based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

PaymentMethod object that needs to be added

id	integer Unique identifier for the payment method
customer_id required	integer ID of the associated customer
payment_provider_id required	integer ID of the associated payment provider
payment_provider_method_id	string Identifier for the payment method in the provider's system
status required	string Enum: "active" "inactive" "blocked" Current status of the payment method
payment_method_type required	string Type of the payment method (e.g., card, bank account)
is_default	boolean Indicates if this is the default payment method
pan	string Payment account number (e.g., credit card number, account number)
phone	string Associated phone number
email	string Associated email address
expires_at	string <date-time> Timestamp when the payment method expires
created_at	string <date-time> Timestamp when the payment method was created
updated_at	string <date-time> Timestamp when the payment method was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an payment method by ID

Retrieves an payment method based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('payment_methods').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an payment method by ID

Updates an payment method based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

PaymentMethod object that needs to be updated

id	integer Unique identifier for the payment method
customer_id required	integer ID of the associated customer
payment_provider_id required	integer ID of the associated payment provider
payment_provider_method_id	string Identifier for the payment method in the provider's system
status required	string Enum: "active" "inactive" "blocked" Current status of the payment method
payment_method_type required	string Type of the payment method (e.g., card, bank account)
is_default	boolean Indicates if this is the default payment method
pan	string Payment account number (e.g., credit card number, account number)
phone	string Associated phone number
email	string Associated email address
expires_at	string <date-time> Timestamp when the payment method expires
created_at	string <date-time> Timestamp when the payment method was created
updated_at	string <date-time> Timestamp when the payment method was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an payment method by ID

Patches an payment method based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

PaymentMethod object that needs to be updated

id	integer Unique identifier for the payment method
customer_id required	integer ID of the associated customer
payment_provider_id required	integer ID of the associated payment provider
payment_provider_method_id	string Identifier for the payment method in the provider's system
status required	string Enum: "active" "inactive" "blocked" Current status of the payment method
payment_method_type required	string Type of the payment method (e.g., card, bank account)
is_default	boolean Indicates if this is the default payment method
pan	string Payment account number (e.g., credit card number, account number)
phone	string Associated phone number
email	string Associated email address
expires_at	string <date-time> Timestamp when the payment method expires
created_at	string <date-time> Timestamp when the payment method was created
updated_at	string <date-time> Timestamp when the payment method was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 123,
"payment_provider_id": 1,
"payment_provider_method_id": "method123",
"status": "active",
"payment_method_type": "credit_card",
"is_default": true,
"pan": "4111111111111111",
"phone": "+1234567890",
"email": "customer@example.com",
"expires_at": "2025-11-16T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an payment method by ID

Deletes an payment method based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Orders

Retrieve a list of Orders

Returns a list of Orders.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('orders').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new order

Creates a new order based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Order object that needs to be added

id	integer Unique identifier for the order
provider_order_id	string External order ID from the provider
customer_id required	integer ID of the associated customer
account_id required	integer ID of the associated account
title	string Title of the order
description	string Detailed description of the order
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order
currency required	string Currency of the order
price	integer Price of the order in minor units (e.g., cents)
discount	integer Discount applied to the order in minor units
shipping_fee	integer Shipping fee for the order in minor units
amount required	integer Total amount for the order in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
billing_country	string Billing country of the customer
billing_state	string Billing state of the customer
billing_street	string Billing street address of the customer
billing_city	string Billing city of the customer
billing_zip	string Billing ZIP code of the customer
shipping_tracking_number	string Tracking number for the shipping
shipping_country	string Shipping country of the order
shipping_state	string Shipping state of the order
shipping_street	string Shipping street address of the order
shipping_city	string Shipping city of the order
shipping_zip	string Shipping ZIP code of the order
notes	string Additional notes for the order
next_actions	object A JSON object containing the next actions for the order
meta	object A JSON object containing custom meta data
redirect_url	string URL for redirection after the order is processed
estimated_delivery_at	string <date-time> Estimated delivery date for the order
created_at	string <date-time> Timestamp when the order was created
updated_at	string <date-time> Timestamp when the order was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an order by ID

Retrieves an order based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('orders').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an order by ID

Updates an order based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Order object that needs to be updated

id	integer Unique identifier for the order
provider_order_id	string External order ID from the provider
customer_id required	integer ID of the associated customer
account_id required	integer ID of the associated account
title	string Title of the order
description	string Detailed description of the order
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order
currency required	string Currency of the order
price	integer Price of the order in minor units (e.g., cents)
discount	integer Discount applied to the order in minor units
shipping_fee	integer Shipping fee for the order in minor units
amount required	integer Total amount for the order in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
billing_country	string Billing country of the customer
billing_state	string Billing state of the customer
billing_street	string Billing street address of the customer
billing_city	string Billing city of the customer
billing_zip	string Billing ZIP code of the customer
shipping_tracking_number	string Tracking number for the shipping
shipping_country	string Shipping country of the order
shipping_state	string Shipping state of the order
shipping_street	string Shipping street address of the order
shipping_city	string Shipping city of the order
shipping_zip	string Shipping ZIP code of the order
notes	string Additional notes for the order
next_actions	object A JSON object containing the next actions for the order
meta	object A JSON object containing custom meta data
redirect_url	string URL for redirection after the order is processed
estimated_delivery_at	string <date-time> Estimated delivery date for the order
created_at	string <date-time> Timestamp when the order was created
updated_at	string <date-time> Timestamp when the order was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an order by ID

Patches an order based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Order object that needs to be updated

id	integer Unique identifier for the order
provider_order_id	string External order ID from the provider
customer_id required	integer ID of the associated customer
account_id required	integer ID of the associated account
title	string Title of the order
description	string Detailed description of the order
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order
currency required	string Currency of the order
price	integer Price of the order in minor units (e.g., cents)
discount	integer Discount applied to the order in minor units
shipping_fee	integer Shipping fee for the order in minor units
amount required	integer Total amount for the order in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
billing_country	string Billing country of the customer
billing_state	string Billing state of the customer
billing_street	string Billing street address of the customer
billing_city	string Billing city of the customer
billing_zip	string Billing ZIP code of the customer
shipping_tracking_number	string Tracking number for the shipping
shipping_country	string Shipping country of the order
shipping_state	string Shipping state of the order
shipping_street	string Shipping street address of the order
shipping_city	string Shipping city of the order
shipping_zip	string Shipping ZIP code of the order
notes	string Additional notes for the order
next_actions	object A JSON object containing the next actions for the order
meta	object A JSON object containing custom meta data
redirect_url	string URL for redirection after the order is processed
estimated_delivery_at	string <date-time> Estimated delivery date for the order
created_at	string <date-time> Timestamp when the order was created
updated_at	string <date-time> Timestamp when the order was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an order by ID

Deletes an order based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

OrderLines

Retrieve a list of OrderLines

Returns a list of OrderLines.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('order_lines').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new order line

Creates a new order line based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

OrderLine object that needs to be added

id	integer Unique identifier for the order line
order_id required	integer ID of the associated order
quantity	integer Quantity of items in the order line
type required	string Enum: "product" "service" "subscription" Type of item in the order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order line
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order line
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
tax_code	string Tax code for the order line
currency required	string Currency of the order line
price	integer Price of the order line in minor units (e.g., cents)
discount	integer Discount applied to the order line in minor units
shipping_fee	integer Shipping fee for the order line in minor units
amount required	integer Total amount for the order line in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order line amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order line amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
title	string Title of the order line item
description	string Detailed description of the order line item
billing_country	string Billing country for the order line
billing_state	string Billing state for the order line
billing_street	string Billing street address for the order line
billing_city	string Billing city for the order line
billing_zip	string Billing ZIP code for the order line
shipping_tracking_number	string Tracking number for shipping the order line item
shipping_country	string Shipping country for the order line
shipping_state	string Shipping state for the order line
shipping_street	string Shipping street address for the order line
shipping_city	string Shipping city for the order line
shipping_zip	string Shipping ZIP code for the order line
notes	string Additional notes for the order line
estimated_delivery_at	string <date-time> Estimated delivery date for the order line item
redirect_url	string URL for redirection after the order line is processed
created_at	string <date-time> Timestamp when the order line was created
updated_at	string <date-time> Timestamp when the order line was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an order line by ID

Retrieves an order line based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('order_lines').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an order line by ID

Updates an order line based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

OrderLine object that needs to be updated

id	integer Unique identifier for the order line
order_id required	integer ID of the associated order
quantity	integer Quantity of items in the order line
type required	string Enum: "product" "service" "subscription" Type of item in the order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order line
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order line
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
tax_code	string Tax code for the order line
currency required	string Currency of the order line
price	integer Price of the order line in minor units (e.g., cents)
discount	integer Discount applied to the order line in minor units
shipping_fee	integer Shipping fee for the order line in minor units
amount required	integer Total amount for the order line in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order line amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order line amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
title	string Title of the order line item
description	string Detailed description of the order line item
billing_country	string Billing country for the order line
billing_state	string Billing state for the order line
billing_street	string Billing street address for the order line
billing_city	string Billing city for the order line
billing_zip	string Billing ZIP code for the order line
shipping_tracking_number	string Tracking number for shipping the order line item
shipping_country	string Shipping country for the order line
shipping_state	string Shipping state for the order line
shipping_street	string Shipping street address for the order line
shipping_city	string Shipping city for the order line
shipping_zip	string Shipping ZIP code for the order line
notes	string Additional notes for the order line
estimated_delivery_at	string <date-time> Estimated delivery date for the order line item
redirect_url	string URL for redirection after the order line is processed
created_at	string <date-time> Timestamp when the order line was created
updated_at	string <date-time> Timestamp when the order line was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an order line by ID

Patches an order line based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

OrderLine object that needs to be updated

id	integer Unique identifier for the order line
order_id required	integer ID of the associated order
quantity	integer Quantity of items in the order line
type required	string Enum: "product" "service" "subscription" Type of item in the order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order line
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order line
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
tax_code	string Tax code for the order line
currency required	string Currency of the order line
price	integer Price of the order line in minor units (e.g., cents)
discount	integer Discount applied to the order line in minor units
shipping_fee	integer Shipping fee for the order line in minor units
amount required	integer Total amount for the order line in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order line amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order line amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
title	string Title of the order line item
description	string Detailed description of the order line item
billing_country	string Billing country for the order line
billing_state	string Billing state for the order line
billing_street	string Billing street address for the order line
billing_city	string Billing city for the order line
billing_zip	string Billing ZIP code for the order line
shipping_tracking_number	string Tracking number for shipping the order line item
shipping_country	string Shipping country for the order line
shipping_state	string Shipping state for the order line
shipping_street	string Shipping street address for the order line
shipping_city	string Shipping city for the order line
shipping_zip	string Shipping ZIP code for the order line
notes	string Additional notes for the order line
estimated_delivery_at	string <date-time> Estimated delivery date for the order line item
redirect_url	string URL for redirection after the order line is processed
created_at	string <date-time> Timestamp when the order line was created
updated_at	string <date-time> Timestamp when the order line was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"quantity": 2,
"type": "product",
"status": "pending",
"shipping_status": "shipped",
"product_id": 1001,
"service_id": 2001,
"subscription_id": 3001,
"tax_code": "TAX123",
"currency": "USD",
"price": 5000,
"discount": 500,
"shipping_fee": 100,
"amount": 4600,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 4000,
"account_vat": 400,
"account_provider_fee": 200,
"account_passthrough_fee": 50,
"account_application_fee": 100,
"account_net": 3500,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 600,
"platform_vat": 60,
"platform_provider_fee": 30,
"platform_passthrough_fee": 20,
"platform_net": 500,
"title": "Laptop",
"description": "A new laptop and accessories.",
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"redirect_url": "https://example.com/order/line/1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an order line by ID

Deletes an order line based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

OrderHistories

Retrieve a list of OrderHistories

Returns a list of OrderHistories.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('order_history').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new order history

Creates a new order history based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

OrderHistory object that needs to be added

id	integer Unique identifier for the order history entry
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order in the history entry
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status for the order line in the history entry
notes	string Optional notes related to the status change
user_id	integer ID of the user who made the change (null = system)
created_at	string <date-time> Timestamp when the order history entry was created
updated_at	string <date-time> Timestamp when the order history entry was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an order history by ID

Retrieves an order history based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('order_history').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an order history by ID

Updates an order history based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

OrderHistory object that needs to be updated

id	integer Unique identifier for the order history entry
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order in the history entry
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status for the order line in the history entry
notes	string Optional notes related to the status change
user_id	integer ID of the user who made the change (null = system)
created_at	string <date-time> Timestamp when the order history entry was created
updated_at	string <date-time> Timestamp when the order history entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an order history by ID

Patches an order history based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

OrderHistory object that needs to be updated

id	integer Unique identifier for the order history entry
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order in the history entry
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status for the order line in the history entry
notes	string Optional notes related to the status change
user_id	integer ID of the user who made the change (null = system)
created_at	string <date-time> Timestamp when the order history entry was created
updated_at	string <date-time> Timestamp when the order history entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"order_id": 1,
"order_line_id": 1001,
"status": "pending",
"shipping_status": "shipped",
"notes": "Item shipped on time",
"user_id": 42,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an order history by ID

Deletes an order history based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

AccountPaymentProviders

Retrieve a list of AccountPaymentProviders

Returns a list of AccountPaymentProviders.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('account_payment_providers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new account payment provider

Creates a new account payment provider based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

AccountPaymentProvider object that needs to be added

id	integer Unique identifier for the account payment provider entry
account_id required	integer ID of the associated account
payment_provider_id required	integer ID of the associated payment provider
provider_account_id	string Provider's unique account ID for this payment provider
login_link	string Link to providers dashboard
onboard_link	string Link to provider onboarding
tos_accepted_at	string <date-time> Timestamp when the terms of service were accepted
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an account payment provider by ID

Retrieves an account payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('account_payment_providers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an account payment provider by ID

Updates an account payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AccountPaymentProvider object that needs to be updated

id	integer Unique identifier for the account payment provider entry
account_id required	integer ID of the associated account
payment_provider_id required	integer ID of the associated payment provider
provider_account_id	string Provider's unique account ID for this payment provider
login_link	string Link to providers dashboard
onboard_link	string Link to provider onboarding
tos_accepted_at	string <date-time> Timestamp when the terms of service were accepted
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an account payment provider by ID

Patches an account payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

AccountPaymentProvider object that needs to be updated

id	integer Unique identifier for the account payment provider entry
account_id required	integer ID of the associated account
payment_provider_id required	integer ID of the associated payment provider
provider_account_id	string Provider's unique account ID for this payment provider
login_link	string Link to providers dashboard
onboard_link	string Link to provider onboarding
tos_accepted_at	string <date-time> Timestamp when the terms of service were accepted
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an account payment provider by ID

Deletes an account payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Connect account to payment provider

Connects account to payment provider.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Slug for payment provider and account id

account_id	number
slug	string

Responses

Request samples

Payload
Feathers

Content type

application/json

{"account_id": 0,
"slug": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"account_id": 42,
"payment_provider_id": 5,
"provider_account_id": "abc123xyz",
"login_link": "https://",
"onboard_link": "https://",
"tos_accepted_at": "2024-11-16T12:34:56Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Onboard account to payment provider

Onboards account to payment provider.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Slug for payment provider and account id

account_id	number
slug	string

Responses

Request samples

Payload
Feathers

Content type

application/json

{"account_id": 0,
"slug": "string"
}

Response samples

201
400
500

Content type

application/json

{"redirect_url": "string"
}

ProductTags

Retrieve a list of ProductTags

Returns a list of ProductTags.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('product_tags').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new product tag

Creates a new product tag based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ProductTag object that needs to be added

id	integer Unique identifier for the product tag entry
product_id required	integer ID of the associated product
tag_id required	integer ID of the associated tag
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an product tag by ID

Retrieves an product tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('product_tags').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an product tag by ID

Updates an product tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ProductTag object that needs to be updated

id	integer Unique identifier for the product tag entry
product_id required	integer ID of the associated product
tag_id required	integer ID of the associated tag
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an product tag by ID

Patches an product tag based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ProductTag object that needs to be updated

id	integer Unique identifier for the product tag entry
product_id required	integer ID of the associated product
tag_id required	integer ID of the associated tag
created_at	string <date-time> Timestamp when the entry was created
updated_at	string <date-time> Timestamp when the entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"tag_id": 7,
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an product tag by ID

Deletes an product tag based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

ProductMedias

Retrieve a list of ProductMedias

Returns a list of ProductMedias.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('product_media').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new product media

Creates a new product media based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

ProductMedia object that needs to be added

id	integer Unique identifier for the product media entry
product_id required	integer ID of the associated product
type required	string Enum: "image" "video" "audio" Type of media (image, video, or audio)
url	string URL to the media file
created_at	string <date-time> Timestamp when the media entry was created
updated_at	string <date-time> Timestamp when the media entry was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an product media by ID

Retrieves an product media based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('product_media').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an product media by ID

Updates an product media based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ProductMedia object that needs to be updated

id	integer Unique identifier for the product media entry
product_id required	integer ID of the associated product
type required	string Enum: "image" "video" "audio" Type of media (image, video, or audio)
url	string URL to the media file
created_at	string <date-time> Timestamp when the media entry was created
updated_at	string <date-time> Timestamp when the media entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an product media by ID

Patches an product media based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

ProductMedia object that needs to be updated

id	integer Unique identifier for the product media entry
product_id required	integer ID of the associated product
type required	string Enum: "image" "video" "audio" Type of media (image, video, or audio)
url	string URL to the media file
created_at	string <date-time> Timestamp when the media entry was created
updated_at	string <date-time> Timestamp when the media entry was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"product_id": 42,
"type": "image",
"url": "https://example.com/media/product-image.jpg",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an product media by ID

Deletes an product media based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Reviews

Retrieve a list of Reviews

Returns a list of Reviews.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('reviews').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new review

Creates a new review based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Review object that needs to be added

id	integer Unique identifier for the review
type required	string Enum: "product" "service" "plan" The type of item being reviewed (product, service, or plan)
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
plan_id	integer ID of the associated plan (if applicable)
customer_id required	integer ID of the customer who submitted the review
review required	string Text of the review
created_at	string <date-time> Timestamp when the review was created
updated_at	string <date-time> Timestamp when the review was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an review by ID

Retrieves an review based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('reviews').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an review by ID

Updates an review based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Review object that needs to be updated

id	integer Unique identifier for the review
type required	string Enum: "product" "service" "plan" The type of item being reviewed (product, service, or plan)
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
plan_id	integer ID of the associated plan (if applicable)
customer_id required	integer ID of the customer who submitted the review
review required	string Text of the review
created_at	string <date-time> Timestamp when the review was created
updated_at	string <date-time> Timestamp when the review was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an review by ID

Patches an review based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Review object that needs to be updated

id	integer Unique identifier for the review
type required	string Enum: "product" "service" "plan" The type of item being reviewed (product, service, or plan)
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
plan_id	integer ID of the associated plan (if applicable)
customer_id required	integer ID of the customer who submitted the review
review required	string Text of the review
created_at	string <date-time> Timestamp when the review was created
updated_at	string <date-time> Timestamp when the review was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"type": "product",
"product_id": 42,
"service_id": 15,
"plan_id": 5,
"customer_id": 1001,
"review": "Great product, really satisfied with the performance.",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an review by ID

Deletes an review based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Payments

Retrieve a list of Payments

Returns a list of Payments.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('payments').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new payment

Creates a new payment based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Payment object that needs to be added

id	integer Unique identifier for the payment
parent_id	integer ID of the parent payment (if applicable)
type required	string Enum: "charge" "refund" "payout" "top-up" "transfer" "transfer-reversal" Type of payment transaction
title	string Title of the payment
description	string Detailed description of the payment
attempt_count	integer Number of payment attempts
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
currency required	string Currency of the payment
price	integer Original price before discounts or fees
discount	integer Discount applied to the payment
shipping_fee	integer Shipping fee for the payment
amount required	integer Total amount after all adjustments (price + shipping fee - discount)
balance	integer Remaining balance after payment
account_currency required	string Currency for the connected account
account_exchange_rate	number Exchange rate for the account currency
account_amount	integer Amount for the connected account
account_vat	integer VAT for the connected account
account_provider_fee	integer Provider fee for the connected account
account_passthrough_fee	integer Passthrough fee for the connected account
account_application_fee	integer Application fee for the connected account
account_net	integer Net amount for the connected account
platform_currency required	string Currency for the platform
platform_exchange_rate	number Exchange rate for the platform currency
platform_amount	integer Amount for the platform
platform_vat	integer VAT for the platform
platform_provider_fee	integer Provider fee for the platform
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount for the platform
status	string Enum: "pending" "captured" "captured-partially" "refunded" "refunded-partially" "transfered" "transfered-partially" "failed" Payment status
message	string Additional message related to the payment
checkout_session_id	string Checkout session ID
transaction_id	string Transaction ID for the payment
agreement_id	string Agreement ID associated with the payment
customer_id	integer ID of the customer who made the payment
account_id	integer ID of the account related to the payment
account_receiver_id	integer ID of the account receiving the payment
payment_provider_id required	integer ID of the payment provider
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
billing_country	string Billing country
billing_state	string Billing state
billing_street	string Billing street address
billing_city	string Billing city
billing_zip	string Billing zip code
shipping_tracking_number	string Shipping tracking number
shipping_country	string Shipping country
shipping_state	string Shipping state
shipping_street	string Shipping street address
shipping_city	string Shipping city
shipping_zip	string Shipping zip code
invoice_url	string URL to the invoice
credit_note_url	string URL to the credit note
notes	string Additional notes for the payment
estimated_delivery_at	string <date-time> Estimated delivery date
due_at	string <date-time> Due date for payment
created_at	string <date-time> Timestamp when the payment was created
updated_at	string <date-time> Timestamp when the payment was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an payment by ID

Retrieves an payment based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('payments').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an payment by ID

Updates an payment based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Payment object that needs to be updated

id	integer Unique identifier for the payment
parent_id	integer ID of the parent payment (if applicable)
type required	string Enum: "charge" "refund" "payout" "top-up" "transfer" "transfer-reversal" Type of payment transaction
title	string Title of the payment
description	string Detailed description of the payment
attempt_count	integer Number of payment attempts
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
currency required	string Currency of the payment
price	integer Original price before discounts or fees
discount	integer Discount applied to the payment
shipping_fee	integer Shipping fee for the payment
amount required	integer Total amount after all adjustments (price + shipping fee - discount)
balance	integer Remaining balance after payment
account_currency required	string Currency for the connected account
account_exchange_rate	number Exchange rate for the account currency
account_amount	integer Amount for the connected account
account_vat	integer VAT for the connected account
account_provider_fee	integer Provider fee for the connected account
account_passthrough_fee	integer Passthrough fee for the connected account
account_application_fee	integer Application fee for the connected account
account_net	integer Net amount for the connected account
platform_currency required	string Currency for the platform
platform_exchange_rate	number Exchange rate for the platform currency
platform_amount	integer Amount for the platform
platform_vat	integer VAT for the platform
platform_provider_fee	integer Provider fee for the platform
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount for the platform
status	string Enum: "pending" "captured" "captured-partially" "refunded" "refunded-partially" "transfered" "transfered-partially" "failed" Payment status
message	string Additional message related to the payment
checkout_session_id	string Checkout session ID
transaction_id	string Transaction ID for the payment
agreement_id	string Agreement ID associated with the payment
customer_id	integer ID of the customer who made the payment
account_id	integer ID of the account related to the payment
account_receiver_id	integer ID of the account receiving the payment
payment_provider_id required	integer ID of the payment provider
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
billing_country	string Billing country
billing_state	string Billing state
billing_street	string Billing street address
billing_city	string Billing city
billing_zip	string Billing zip code
shipping_tracking_number	string Shipping tracking number
shipping_country	string Shipping country
shipping_state	string Shipping state
shipping_street	string Shipping street address
shipping_city	string Shipping city
shipping_zip	string Shipping zip code
invoice_url	string URL to the invoice
credit_note_url	string URL to the credit note
notes	string Additional notes for the payment
estimated_delivery_at	string <date-time> Estimated delivery date
due_at	string <date-time> Due date for payment
created_at	string <date-time> Timestamp when the payment was created
updated_at	string <date-time> Timestamp when the payment was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an payment by ID

Patches an payment based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Payment object that needs to be updated

id	integer Unique identifier for the payment
parent_id	integer ID of the parent payment (if applicable)
type required	string Enum: "charge" "refund" "payout" "top-up" "transfer" "transfer-reversal" Type of payment transaction
title	string Title of the payment
description	string Detailed description of the payment
attempt_count	integer Number of payment attempts
product_id	integer ID of the associated product (if applicable)
service_id	integer ID of the associated service (if applicable)
subscription_id	integer ID of the associated subscription (if applicable)
currency required	string Currency of the payment
price	integer Original price before discounts or fees
discount	integer Discount applied to the payment
shipping_fee	integer Shipping fee for the payment
amount required	integer Total amount after all adjustments (price + shipping fee - discount)
balance	integer Remaining balance after payment
account_currency required	string Currency for the connected account
account_exchange_rate	number Exchange rate for the account currency
account_amount	integer Amount for the connected account
account_vat	integer VAT for the connected account
account_provider_fee	integer Provider fee for the connected account
account_passthrough_fee	integer Passthrough fee for the connected account
account_application_fee	integer Application fee for the connected account
account_net	integer Net amount for the connected account
platform_currency required	string Currency for the platform
platform_exchange_rate	number Exchange rate for the platform currency
platform_amount	integer Amount for the platform
platform_vat	integer VAT for the platform
platform_provider_fee	integer Provider fee for the platform
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount for the platform
status	string Enum: "pending" "captured" "captured-partially" "refunded" "refunded-partially" "transfered" "transfered-partially" "failed" Payment status
message	string Additional message related to the payment
checkout_session_id	string Checkout session ID
transaction_id	string Transaction ID for the payment
agreement_id	string Agreement ID associated with the payment
customer_id	integer ID of the customer who made the payment
account_id	integer ID of the account related to the payment
account_receiver_id	integer ID of the account receiving the payment
payment_provider_id required	integer ID of the payment provider
order_id required	integer ID of the associated order
order_line_id	integer ID of the associated order line
billing_country	string Billing country
billing_state	string Billing state
billing_street	string Billing street address
billing_city	string Billing city
billing_zip	string Billing zip code
shipping_tracking_number	string Shipping tracking number
shipping_country	string Shipping country
shipping_state	string Shipping state
shipping_street	string Shipping street address
shipping_city	string Shipping city
shipping_zip	string Shipping zip code
invoice_url	string URL to the invoice
credit_note_url	string URL to the credit note
notes	string Additional notes for the payment
estimated_delivery_at	string <date-time> Estimated delivery date
due_at	string <date-time> Due date for payment
created_at	string <date-time> Timestamp when the payment was created
updated_at	string <date-time> Timestamp when the payment was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"parent_id": 10,
"type": "charge",
"title": "Payment for product",
"description": "Payment for the purchase of product X",
"attempt_count": 1,
"product_id": 45,
"service_id": 32,
"subscription_id": 78,
"currency": "USD",
"price": 1000,
"discount": 100,
"shipping_fee": 50,
"amount": 950,
"balance": 0,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 900,
"account_vat": 100,
"account_provider_fee": 50,
"account_passthrough_fee": 20,
"account_application_fee": 30,
"account_net": 700,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 950,
"platform_vat": 100,
"platform_provider_fee": 30,
"platform_passthrough_fee": 10,
"platform_net": 810,
"status": "pending",
"message": "Payment successfully processed",
"checkout_session_id": "session1234",
"transaction_id": "txn12345",
"agreement_id": "agreem6789",
"customer_id": 1234,
"account_id": 5678,
"account_receiver_id": 91011,
"payment_provider_id": 2,
"order_id": 100,
"order_line_id": 200,
"billing_country": "USA",
"billing_state": "California",
"billing_street": "123 Main St",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "tracking1234",
"shipping_country": "USA",
"shipping_state": "California",
"shipping_street": "123 Main St",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"invoice_url": "https://example.com/invoice/123",
"credit_note_url": "https://example.com/credit_note/123",
"notes": "Payment for order 1001",
"estimated_delivery_at": "2024-12-01T12:00:00Z",
"due_at": "2024-11-30T12:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an payment by ID

Deletes an payment based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

CustomerPaymentProviders

Retrieve a list of CustomerPaymentProviders

Returns a list of CustomerPaymentProviders.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('customer_payment_providers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new customer payment provider

Creates a new customer payment provider based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

CustomerPaymentProvider object that needs to be added

id	integer Unique identifier for the customer payment provider relationship
customer_id required	integer ID of the customer associated with the payment provider
payment_provider_id required	integer ID of the payment provider
provider_customer_id	string ID assigned to the customer by the payment provider
created_at	string <date-time> Timestamp when the customer payment provider record was created
updated_at	string <date-time> Timestamp when the customer payment provider record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an customer payment provider by ID

Retrieves an customer payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('customer_payment_providers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an customer payment provider by ID

Updates an customer payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerPaymentProvider object that needs to be updated

id	integer Unique identifier for the customer payment provider relationship
customer_id required	integer ID of the customer associated with the payment provider
payment_provider_id required	integer ID of the payment provider
provider_customer_id	string ID assigned to the customer by the payment provider
created_at	string <date-time> Timestamp when the customer payment provider record was created
updated_at	string <date-time> Timestamp when the customer payment provider record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an customer payment provider by ID

Patches an customer payment provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

CustomerPaymentProvider object that needs to be updated

id	integer Unique identifier for the customer payment provider relationship
customer_id required	integer ID of the customer associated with the payment provider
payment_provider_id required	integer ID of the payment provider
provider_customer_id	string ID assigned to the customer by the payment provider
created_at	string <date-time> Timestamp when the customer payment provider record was created
updated_at	string <date-time> Timestamp when the customer payment provider record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"customer_id": 1234,
"payment_provider_id": 2,
"provider_customer_id": "provider1234",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an customer payment provider by ID

Deletes an customer payment provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Webhooks

Webhook endpoint to receive message from third party services

Receives data from third parties

Request Body schema: application/json
required

Provider slug for payment provider and account id

data

object

Responses

Request samples

Payload

Content type

application/json

{"data": { }
}

Response samples

201
400
500

Content type

application/json

{"status": "received"
}

Verify / complete order

Verifies that order is valid

Request Body schema: application/json
required

Provider slug for payment provider and account id

id	integer Unique identifier for the order
provider_order_id	string External order ID from the provider
customer_id required	integer ID of the associated customer
account_id required	integer ID of the associated account
title	string Title of the order
description	string Detailed description of the order
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order
currency required	string Currency of the order
price	integer Price of the order in minor units (e.g., cents)
discount	integer Discount applied to the order in minor units
shipping_fee	integer Shipping fee for the order in minor units
amount required	integer Total amount for the order in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
billing_country	string Billing country of the customer
billing_state	string Billing state of the customer
billing_street	string Billing street address of the customer
billing_city	string Billing city of the customer
billing_zip	string Billing ZIP code of the customer
shipping_tracking_number	string Tracking number for the shipping
shipping_country	string Shipping country of the order
shipping_state	string Shipping state of the order
shipping_street	string Shipping street address of the order
shipping_city	string Shipping city of the order
shipping_zip	string Shipping ZIP code of the order
notes	string Additional notes for the order
next_actions	object A JSON object containing the next actions for the order
meta	object A JSON object containing custom meta data
redirect_url	string URL for redirection after the order is processed
estimated_delivery_at	string <date-time> Estimated delivery date for the order
created_at	string <date-time> Timestamp when the order was created
updated_at	string <date-time> Timestamp when the order was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"status": "received"
}

Cancel order

Cancels order

Request Body schema: application/json
required

Provider slug for payment provider and account id

id	integer Unique identifier for the order
provider_order_id	string External order ID from the provider
customer_id required	integer ID of the associated customer
account_id required	integer ID of the associated account
title	string Title of the order
description	string Detailed description of the order
status required	string Enum: "draft" "pending" "partial" "cancelled" "completed" "revert-requested" "reverted" Current status of the order
shipping_status	string Enum: "no-shipping" "pending" "picked" "packed" "shipped" "delivered" "returned" Shipping status of the order
currency required	string Currency of the order
price	integer Price of the order in minor units (e.g., cents)
discount	integer Discount applied to the order in minor units
shipping_fee	integer Shipping fee for the order in minor units
amount required	integer Total amount for the order in minor units
account_currency	string Currency used by the connected account
account_exchange_rate	number <float> Exchange rate for the account's currency
account_amount	integer Account's portion of the order amount in minor units
account_vat	integer VAT for the account's portion
account_provider_fee	integer Provider fee deducted from the account's portion
account_passthrough_fee	integer Passthrough fee for the account
account_application_fee	integer Application fee for the account
account_net	integer Net amount received by the account
platform_currency	string Currency used by the platform
platform_exchange_rate	number <float> Exchange rate for the platform's currency
platform_amount	integer Platform's portion of the order amount in minor units
platform_vat	integer VAT for the platform's portion
platform_provider_fee	integer Provider fee deducted from the platform's portion
platform_passthrough_fee	integer Passthrough fee for the platform
platform_net	integer Net amount received by the platform
billing_country	string Billing country of the customer
billing_state	string Billing state of the customer
billing_street	string Billing street address of the customer
billing_city	string Billing city of the customer
billing_zip	string Billing ZIP code of the customer
shipping_tracking_number	string Tracking number for the shipping
shipping_country	string Shipping country of the order
shipping_state	string Shipping state of the order
shipping_street	string Shipping street address of the order
shipping_city	string Shipping city of the order
shipping_zip	string Shipping ZIP code of the order
notes	string Additional notes for the order
next_actions	object A JSON object containing the next actions for the order
meta	object A JSON object containing custom meta data
redirect_url	string URL for redirection after the order is processed
estimated_delivery_at	string <date-time> Estimated delivery date for the order
created_at	string <date-time> Timestamp when the order was created
updated_at	string <date-time> Timestamp when the order was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"provider_order_id": "ORDER12345",
"customer_id": 123,
"account_id": 456,
"title": "Product Purchase",
"description": "Order for a new laptop and accessories.",
"status": "pending",
"shipping_status": "shipped",
"currency": "USD",
"price": 10000,
"discount": 1000,
"shipping_fee": 500,
"amount": 9500,
"account_currency": "USD",
"account_exchange_rate": 1,
"account_amount": 8500,
"account_vat": 1000,
"account_provider_fee": 500,
"account_passthrough_fee": 100,
"account_application_fee": 200,
"account_net": 7000,
"platform_currency": "USD",
"platform_exchange_rate": 1,
"platform_amount": 1000,
"platform_vat": 100,
"platform_provider_fee": 100,
"platform_passthrough_fee": 50,
"platform_net": 850,
"billing_country": "US",
"billing_state": "California",
"billing_street": "1234 Elm Street",
"billing_city": "Los Angeles",
"billing_zip": "90001",
"shipping_tracking_number": "TRACK12345",
"shipping_country": "US",
"shipping_state": "California",
"shipping_street": "1234 Elm Street",
"shipping_city": "Los Angeles",
"shipping_zip": "90001",
"notes": "Handle with care",
"next_actions": {"action": "ship",
"due_date": "2024-11-20"
},
"meta": {"user_id": 1,
"group_id": 1
},
"redirect_url": "https://example.com/order/1",
"estimated_delivery_at": "2024-11-20T00:00:00Z",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"status": "received"
}

Refresh endpoint for Stripe onboarding

If onboarding expires, it will return to this url

query Parameters

acc_pay_provider

required

string

Account provider id to be handled

Responses

Response samples

400
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Return endpoint for Stripe onboarding

If onboarding succeeds, it will return to this url

query Parameters

acc_pay_provider

required

string

Account provider id to be handled

Responses

Response samples

400
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

TaxCodes

Retrieve a list of TaxCodes

Returns a list of TaxCodes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('tax_codes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new tax code

Creates a new tax code based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

TaxCode object that needs to be added

id	integer Unique identifier for the tax code
code required	string The tax code itself
type required	string The type of tax (e.g., 'VAT', 'GST')
description	string Detailed description of the tax code
name required	string Name of the tax code
created_at	string <date-time> Timestamp when the tax code was created
updated_at	string <date-time> Timestamp when the tax code was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve an tax code by ID

Retrieves an tax code based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('tax_codes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an tax code by ID

Updates an tax code based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

TaxCode object that needs to be updated

id	integer Unique identifier for the tax code
code required	string The tax code itself
type required	string The type of tax (e.g., 'VAT', 'GST')
description	string Detailed description of the tax code
name required	string Name of the tax code
created_at	string <date-time> Timestamp when the tax code was created
updated_at	string <date-time> Timestamp when the tax code was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an tax code by ID

Patches an tax code based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

TaxCode object that needs to be updated

id	integer Unique identifier for the tax code
code required	string The tax code itself
type required	string The type of tax (e.g., 'VAT', 'GST')
description	string Detailed description of the tax code
name required	string Name of the tax code
created_at	string <date-time> Timestamp when the tax code was created
updated_at	string <date-time> Timestamp when the tax code was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"code": "TAX123",
"type": "VAT",
"description": "Value Added Tax for general goods",
"name": "Standard VAT",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an tax code by ID

Deletes an tax code based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Errors

Retrieve a list of Errors

Returns a list of Errors.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('errors').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new error

Creates a new error based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Error object that needs to be added

message

required

string

The error message

Responses

Request samples

Payload
Feathers

Content type

application/json

{"message": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an error by ID

Retrieves an error based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('errors').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an error by ID

Updates an error based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Error object that needs to be updated

message

required

string

The error message

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an error by ID

Patches an error based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Error object that needs to be updated

message

required

string

The error message

Responses

Request samples

Payload

Content type

application/json

{"message": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an error by ID

Deletes an error based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

RoleAccessScopes

Retrieve a list of RoleAccessScopes

Returns a list of RoleAccessScopes.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('role_access_scopes').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new role access scope

Creates a new role access scope based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

RoleAccessScope object that needs to be added

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload
Feathers

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an role access scope by ID

Retrieves an role access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('role_access_scopes').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an role access scope by ID

Updates an role access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an role access scope by ID

Patches an role access scope based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

RoleAccessScope object that needs to be updated

role_id required	integer ID of the associated role
access_scope_id required	integer ID of the associated access scope

Responses

Request samples

Payload

Content type

application/json

{"role_id": 0,
"access_scope_id": 0
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an role access scope by ID

Deletes an role access scope based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"role_id": 0,
"access_scope_id": 0,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Roles

Retrieve a list of Roles

Returns a list of Roles.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('roles').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}

Create a new role

Creates a new role based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

Role object that needs to be added

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload
Feathers

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

201
400
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Retrieve an role by ID

Retrieves an role based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 0
app.service('roles').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Update an role by ID

Updates an role based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Role object that needs to be updated

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Patch an role by ID

Patches an role based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

Role object that needs to be updated

name	string Human-readable name of the role
slug required	string Unique slug identifier for the role
description	string Detailed description of the role

Responses

Request samples

Payload

Content type

application/json

{"name": "string",
"slug": "string",
"description": "string"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Delete an role by ID

Deletes an role based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

204
400
404
500

Content type

application/json

{"id": 0,
"name": "string",
"slug": "string",
"description": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

FeathersServices

Retrieve a list of all FeathersJS Services

Returns a list of all FeathersJS Services.

Responses

Request samples

Feathers

app.service('feathers_services').find({ query: {} })

Response samples

200
400
500

Content type

application/json

["string"
]

TierProviders

Retrieve a list of TierProviders

Returns a list of TierProviders.

Authorizations:

bearerAuth

Responses

Request samples

Feathers

app.service('tier_providers').find({ query: {} })

Response samples

200
400
500

Content type

application/json

{"total": 0,
"limit": 0,
"skip": 0,
"data": [{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}
]
}

Create a new tier provider

Creates a new tier provider based on the provided object.

Authorizations:

bearerAuth

Request Body schema: application/json
required

TierProvider object that needs to be added

id	integer Unique identifier for the tier provider
tier_id required	integer Id of the tier
payment_provider_id	integer Id of the payment provider
provider_tier_id	string Id of the tier in the provider's system
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload
Feathers

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

201
400
500

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Retrieve n tier provider by ID

Retrieves a tier provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Request samples

Feathers

const id = 1
app.service('tier_providers').get(id)

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Update an tier provider by ID

Updates an tier provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

TierProvider object that needs to be updated

id	integer Unique identifier for the tier provider
tier_id required	integer Id of the tier
payment_provider_id	integer Id of the payment provider
provider_tier_id	string Id of the tier in the provider's system
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Patch an tier provider by ID

Patches an tier provider based on the provided ID and object.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Request Body schema: application/json
required

TierProvider object that needs to be updated

id	integer Unique identifier for the tier provider
tier_id required	integer Id of the tier
payment_provider_id	integer Id of the payment provider
provider_tier_id	string Id of the tier in the provider's system
created_at	string <date-time> Timestamp when the record was created
updated_at	string <date-time> Timestamp when the record was last updated

Responses

Request samples

Payload

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Response samples

200
400
404
500

Content type

application/json

{"id": 1,
"tier_id": 1,
"payment_provider_id": 1,
"provider_tier_id": "1",
"created_at": "2024-11-16T12:34:56Z",
"updated_at": "2024-11-16T12:34:56Z"
}

Delete an tier provider by ID

Deletes an tier provider based on the provided ID.

Authorizations:

bearerAuth

path Parameters

id

required

integer

Responses

Response samples

400
404
500

Content type

application/json

{"id": 0,
"message": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}

Vue Play Market API (1.0.0)

Authentication

User login

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Access Scopes

Retrieve a list of Access Scopes

Authorizations:

Responses

Request samples

Response samples

Create a new access scope

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an access scope by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update an access scope by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch an access scope by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an access scope by ID

Authorizations:

path Parameters

Responses

Response samples

Accounts

Retrieve a list of Accounts

Authorizations:

Responses

Request samples

Response samples

Create a new account

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Retrieve an account by ID

Authorizations:

path Parameters

Responses

Request samples

Response samples

Update an account by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Patch an account by ID

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete an account by ID

Authorizations:

path Parameters

Responses

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required