Skip to navigation

Tool reference

Once you’ve connected your assistant, it can use the tools below. Tools are grouped by what they work with, and each group lists the permission it needs. Your assistant only sees the tools you’ve granted access to.

Tools marked Write change your business, such as creating or deleting a payment link. Your assistant asks you to confirm before running them.

The API reference column links to the matching Yoco API operation, where you’ll find full request and response details.

Payments

Permission required: business/orders:read

ToolDescriptionAPI reference
list_paymentsList and filter paymentsGET /v1/payments/
get_paymentRetrieve a single paymentGET /v1/payments/{payment_id}

Orders

Read tools require business/orders:read. Write tools also require business/orders:write.

ToolDescriptionAPI reference
list_ordersList and filter ordersGET /v1/orders/
get_orderRetrieve a single orderGET /v1/orders/{order_id}
create_order WriteCreate an orderPOST /v1/orders/

Refunds

Permission required: business/orders:read

ToolDescriptionAPI reference
list_refundsList and filter refundsGET /v1/refunds/
get_refundRetrieve a single refundGET /v1/refunds/{refund_id}

Read tools require business/orders:read. Write tools also require business/orders:write.

ToolDescriptionAPI reference
list_payment_linksList and filter payment linksGET /v1/payment_links/
get_payment_linkRetrieve a single payment linkGET /v1/payment_links/{payment_link_id}
create_payment_link WriteCreate a shareable payment linkPOST /v1/payment_links/
delete_payment_link WriteDelete a payment linkDELETE /v1/payment_links/{payment_link_id}

Payouts

Permission required: business/payouts:read

ToolDescriptionAPI reference
list_payoutsList and filter payoutsGET /v1/payouts/
get_payoutRetrieve a single payoutGET /v1/payouts/{payout_id}
list_payout_entriesList the entries that make up a payoutGET /v1/payouts/{payout_id}/payout_entries

Catalogue

Read tools require business/catalogue:read. Write tools also require business/catalogue:write.

ToolDescriptionAPI reference
list_itemsList and filter catalogue items, including availability and prices at a locationGET /v1/items/
get_itemRetrieve a single itemGET /v1/items/{item_id}
create_item WriteCreate an itemPOST /v1/items/
update_item WriteReplace an itemPUT /v1/items/{item_id}
delete_item WriteDelete an itemDELETE /v1/items/{item_id}
list_item_categoriesList catalogue categoriesGET /v1/item_categories/
get_item_categoryRetrieve a single categoryGET /v1/item_categories/{item_category_id}
create_item_category WriteCreate a categoryPOST /v1/item_categories/
update_item_category WriteReplace a categoryPUT /v1/item_categories/{item_category_id}
delete_item_category WriteDelete a categoryDELETE /v1/item_categories/{item_category_id}
list_item_brandsList catalogue brandsGET /v1/item_brands/
get_item_brandRetrieve a single brandGET /v1/item_brands/{item_brand_id}
create_item_brand WriteCreate a brandPOST /v1/item_brands/
update_item_brand WriteReplace a brandPUT /v1/item_brands/{item_brand_id}
delete_item_brand WriteDelete a brandDELETE /v1/item_brands/{item_brand_id}
list_modifier_groupsList modifier groupsGET /v1/modifier_groups/
get_modifier_groupRetrieve a single modifier groupGET /v1/modifier_groups/{modifier_group_id}
create_modifier_group WriteCreate a modifier groupPOST /v1/modifier_groups/
update_modifier_group WriteReplace a modifier groupPUT /v1/modifier_groups/{modifier_group_id}
delete_modifier_group WriteDelete a modifier groupDELETE /v1/modifier_groups/{modifier_group_id}
upload_media WriteUpload an image for an item, brand or categoryPOST /v1/media/
list_taxesList your business taxesGET /v1/taxes/
get_taxRetrieve a single taxGET /v1/taxes/{tax_id}

Locations

Permission required: business/locations:read

ToolDescriptionAPI reference
list_locationsList and filter your business locationsGET /v1/locations/
get_locationRetrieve a single locationGET /v1/locations/{location_id}

Staff

Permission required: business/staff:read

ToolDescriptionAPI reference
list_staffList and filter your business staffGET /v1/staff/
get_staffRetrieve a single staff memberGET /v1/staff/{staff_id}