{"openapi":"3.1.0","info":{"title":"yoco-api","description":"The Yoco API has everything you need to get building with Yoco.","version":"1.0.0"},"servers":[{"url":"https://api.yoco.com","description":"Production"},{"url":"https://api.yocosandbox.com","description":"Sandbox"}],"paths":{"/v1/capital/active_offers":{"get":{"tags":["Capital"],"summary":"List active Capital offers","description":"List active Capital offers\n\n**Required scope: `business/capital_offers:read`**","operationId":"list_active_capital_offers_v1_capital_active_offers_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_CapitalOffer_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1748253969559-12951c6c-8033-44ee-ba87-539232f6fac9","business_id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","provider_name":"Yoco Capital","max_principal_amount":{"amount":5000000,"currency":"ZAR"},"created_at":"2024-11-19T15:27:02+00:00","expires_at":"2024-12-19T15:27:02+00:00"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}}}}}},"security":[{"Bearer":[]}]}},"/v1/capital/active_advances":{"get":{"tags":["Capital"],"summary":"List active Capital advances","description":"List active Capital advances\n\n**Required scope: `business/capital_advances:read`**","operationId":"list_active_capital_advances_v1_capital_active_advances_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_CapitalAdvance_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"b1094ef1-c8c0-4a3e-9b9e-3f5786f72f54","business_id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","provider_name":"Yoco Capital","repayment_rate":"0.1","principal_amount":{"amount":15000000,"currency":"ZAR"},"total_payable_amount":{"amount":28400000,"currency":"ZAR"},"total_paid_amount":{"amount":10000000,"currency":"ZAR"},"created_at":"2025-09-01T08:28:17.367000Z"}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}}}}}},"security":[{"Bearer":[]}]}},"/v1/card_machines/":{"get":{"tags":["Card machines"],"summary":"List card machines","description":"List card machines\n\n**Required scope: `business/devices:read`**","operationId":"list_card_machines_v1_card_machines__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_CardMachine_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","nickname":"Front counter","serial_number":"S1F2102000123","stocked_at":"2024-02-01T00:00:00+02:00","allocation":{"allocated_at":"2024-03-15T09:12:44+02:00","condition":"refurbished"},"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/card_machines/{card_machine_id}":{"get":{"tags":["Card machines"],"summary":"Fetch a card machine","description":"Fetch a card machine\n\n**Required scope: `business/devices:read`**","operationId":"fetch_card_machine_v1_card_machines__card_machine_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"card_machine_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the card machine.","title":"Card Machine Id"},"description":"The unique identifier of the card machine."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CardMachine"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/item_brands/":{"get":{"tags":["Item Brands"],"summary":"List item brands","description":"List item brands\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"list_item_brands_v1_item_brands__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ItemBrand_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337","name":"Acme","description":"Everyday products, built to last.","image":{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"post":{"tags":["Item Brands"],"summary":"Create an item brand","description":"Create an item brand\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"create_item_brand_v1_item_brands__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateItemBrandRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemBrand"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}}},"/v1/item_brands/{item_brand_id}":{"get":{"tags":["Item Brands"],"summary":"Fetch an item brand","description":"Fetch an item brand\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"fetch_item_brand_v1_item_brands__item_brand_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"item_brand_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item brand.","title":"Item Brand Id"},"description":"The unique identifier of the item brand."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemBrand"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"put":{"tags":["Item Brands"],"summary":"Update an item brand","description":"Replace an item brand. The request carries every field, and `null` clears a value.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"update_item_brand_v1_item_brands__item_brand_id__put","security":[{"Bearer":[]}],"parameters":[{"name":"item_brand_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item brand.","title":"Item Brand Id"},"description":"The unique identifier of the item brand."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemBrandRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemBrand"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}},"delete":{"tags":["Item Brands"],"summary":"Delete an item brand","description":"Delete an item brand. Items that belong to the brand no longer belong to any brand: their `brand_id` becomes `null`.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"delete_item_brand_v1_item_brands__item_brand_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"item_brand_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item brand.","title":"Item Brand Id"},"description":"The unique identifier of the item brand."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/item_categories/":{"get":{"tags":["Item Categories"],"summary":"List item categories","description":"List item categories\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"list_item_categories_v1_item_categories__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ItemCategory_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","name":"Hot Beverages","description":"A home for all our tasty warm beverages.","image":{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","parent_category":{"id":"1757511225824-ab79f3ee-5a21-4bca-a060-ef27d9aae788","name":"Beverages","description":"A home for all our beverages.","image":{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"post":{"tags":["Item Categories"],"summary":"Create an item category","description":"Create an item category\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"create_item_category_v1_item_categories__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateItemCategoryRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategory"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}}},"/v1/item_categories/{item_category_id}":{"get":{"tags":["Item Categories"],"summary":"Fetch an item category","description":"Fetch an item category\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"fetch_item_category_v1_item_categories__item_category_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"item_category_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item category.","title":"Item Category Id"},"description":"The unique identifier of the item category."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategory"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"put":{"tags":["Item Categories"],"summary":"Update an item category","description":"Replace an item category. The request carries every field, and `null` clears a value.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"update_item_category_v1_item_categories__item_category_id__put","security":[{"Bearer":[]}],"parameters":[{"name":"item_category_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item category.","title":"Item Category Id"},"description":"The unique identifier of the item category."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemCategoryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategory"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}},"delete":{"tags":["Item Categories"],"summary":"Delete an item category","description":"Delete an item category. Items that belong to the category no longer belong to any category: their `category_id` becomes `null`. Categories whose parent is the deleted category no longer have a parent: their `parent_category` becomes `null`.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"delete_item_category_v1_item_categories__item_category_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"item_category_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item category.","title":"Item Category Id"},"description":"The unique identifier of the item category."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/items/":{"get":{"tags":["Items"],"summary":"List items","description":"List items\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"list_items_v1_items__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"expand","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ExpandableItem"},"description":"Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. `?expand=brand&expand=category`. By default, related entities are returned only as identifiers (e.g. `brand_id`, `category_id`).","title":"Expand"},"description":"Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. `?expand=brand&expand=category`. By default, related entities are returned only as identifiers (e.g. `brand_id`, `category_id`)."},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"description":"Filter items to those available at this location, and resolve variant prices for that location.","title":"Location Id"},"description":"Filter items to those available at this location, and resolve variant prices for that location."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Annotated_Union_ProductItem__ServiceItem___FieldInfo_annotation_NoneType__required_True__discriminator__type____"},"examples":{"product":{"summary":"Product","value":{"data":[{"type":"product","id":"1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef","name":"Flat White","description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","default_price":{"amount":3800,"currency":"ZAR"},"default_barcode":"6009800000015","default_cost_price":{"amount":1200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"item","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}],"next_cursor":"1323935095007282836"}},"product_with_variants":{"summary":"Product with variants","value":{"data":[{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Classic Cotton T-Shirt","description":"100% cotton crew-neck t-shirt with a relaxed fit, available in three sizes.","default_price":{"amount":19900,"currency":"ZAR"},"default_barcode":"5901234123444","default_cost_price":{"amount":8500,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[{"id":"1719321843217-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90","name":"Size","values":[{"name":"Small"},{"name":"Medium"},{"name":"Large"}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"has_multiple_variants":true,"variants":[{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","sku":"TEE-CC-S","barcode":"5901234123451","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Small"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:medium","sku":"TEE-CC-M","barcode":"5901234123468","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Medium"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:large","sku":"TEE-CC-L","barcode":"5901234123475","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Large"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"stock_tracking":"variant","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}],"next_cursor":"1323935095007282836"}},"product_with_modifiers":{"summary":"Product with modifiers","value":{"data":[{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Cheeseburger","description":"A juicy beef patty with melted cheese, lettuce, and tomato on a brioche bun.","default_price":{"amount":8500,"currency":"ZAR"},"default_barcode":"6009800000022","default_cost_price":{"amount":3200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Doneness","min_selections":1,"max_selections":1,"ordinal":0,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Medium-Rare","pricing_strategy":"free","is_selected_by_default":true,"ordinal":0},{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566aa","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Well-Done","pricing_strategy":"free","is_selected_by_default":false,"ordinal":1}]},{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","name":"Side Orders","min_selections":0,"max_selections":2,"ordinal":1,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566bb","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","type":"product","name":"Chips","pricing_strategy":"fixed_price","fixed_price":{"amount":2500,"currency":"ZAR"},"is_selected_by_default":false,"ordinal":0,"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:chips"}]}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}},"service":{"summary":"Service","value":{"data":[{"type":"service","id":"1742394820001-a27d3f6e-4b18-4c92-9e51-2a8fbb4d31c7","name":"Men's Haircut","description":"A classic men's haircut and style finish, including a wash and blow-dry.","default_price":{"amount":25000,"currency":"ZAR"},"default_barcode":"6009800000039","default_cost_price":{"amount":8000,"currency":"ZAR"},"default_duration":30,"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1742394821447-c5f1a902-6d77-4f14-bbe2-09d2c4fa5e88","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"post":{"tags":["Items"],"summary":"Create an item","description":"Create an item\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"create_item_v1_items__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateItemRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProductItem"},{"$ref":"#/components/schemas/ServiceItem"}],"discriminator":{"propertyName":"type","mapping":{"product":"#/components/schemas/ProductItem","service":"#/components/schemas/ServiceItem"}},"title":"Response Create Item V1 Items  Post"},"examples":{"product":{"summary":"Product","value":{"type":"product","id":"1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef","name":"Flat White","description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","default_price":{"amount":3800,"currency":"ZAR"},"default_barcode":"6009800000015","default_cost_price":{"amount":1200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"item","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_variants":{"summary":"Product with variants","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Classic Cotton T-Shirt","description":"100% cotton crew-neck t-shirt with a relaxed fit, available in three sizes.","default_price":{"amount":19900,"currency":"ZAR"},"default_barcode":"5901234123444","default_cost_price":{"amount":8500,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[{"id":"1719321843217-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90","name":"Size","values":[{"name":"Small"},{"name":"Medium"},{"name":"Large"}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"has_multiple_variants":true,"variants":[{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","sku":"TEE-CC-S","barcode":"5901234123451","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Small"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:medium","sku":"TEE-CC-M","barcode":"5901234123468","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Medium"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:large","sku":"TEE-CC-L","barcode":"5901234123475","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Large"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"stock_tracking":"variant","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_modifiers":{"summary":"Product with modifiers","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Cheeseburger","description":"A juicy beef patty with melted cheese, lettuce, and tomato on a brioche bun.","default_price":{"amount":8500,"currency":"ZAR"},"default_barcode":"6009800000022","default_cost_price":{"amount":3200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Doneness","min_selections":1,"max_selections":1,"ordinal":0,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Medium-Rare","pricing_strategy":"free","is_selected_by_default":true,"ordinal":0},{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566aa","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Well-Done","pricing_strategy":"free","is_selected_by_default":false,"ordinal":1}]},{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","name":"Side Orders","min_selections":0,"max_selections":2,"ordinal":1,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566bb","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","type":"product","name":"Chips","pricing_strategy":"fixed_price","fixed_price":{"amount":2500,"currency":"ZAR"},"is_selected_by_default":false,"ordinal":0,"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:chips"}]}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}},"service":{"summary":"Service","value":{"type":"service","id":"1742394820001-a27d3f6e-4b18-4c92-9e51-2a8fbb4d31c7","name":"Men's Haircut","description":"A classic men's haircut and style finish, including a wash and blow-dry.","default_price":{"amount":25000,"currency":"ZAR"},"default_barcode":"6009800000039","default_cost_price":{"amount":8000,"currency":"ZAR"},"default_duration":30,"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1742394821447-c5f1a902-6d77-4f14-bbe2-09d2c4fa5e88","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/items/{item_id}":{"get":{"tags":["Items"],"summary":"Fetch an item","description":"Fetch an item\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"fetch_item_v1_items__item_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item.","title":"Item Id"},"description":"The unique identifier of the item."},{"name":"expand","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/ExpandableItem"}},{"type":"null"}],"description":"Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. `?expand=brand&expand=category`. By default, related entities are returned only as identifiers (e.g. `brand_id`, `category_id`).","title":"Expand"},"description":"Specifies which related entities to inflate in the response. Repeat the parameter to expand multiple entities, e.g. `?expand=brand&expand=category`. By default, related entities are returned only as identifiers (e.g. `brand_id`, `category_id`)."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProductItem"},{"$ref":"#/components/schemas/ServiceItem"}],"discriminator":{"propertyName":"type","mapping":{"product":"#/components/schemas/ProductItem","service":"#/components/schemas/ServiceItem"}},"title":"Response Fetch Item V1 Items  Item Id  Get"},"examples":{"product":{"summary":"Product","value":{"type":"product","id":"1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef","name":"Flat White","description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","default_price":{"amount":3800,"currency":"ZAR"},"default_barcode":"6009800000015","default_cost_price":{"amount":1200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"item","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_variants":{"summary":"Product with variants","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Classic Cotton T-Shirt","description":"100% cotton crew-neck t-shirt with a relaxed fit, available in three sizes.","default_price":{"amount":19900,"currency":"ZAR"},"default_barcode":"5901234123444","default_cost_price":{"amount":8500,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[{"id":"1719321843217-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90","name":"Size","values":[{"name":"Small"},{"name":"Medium"},{"name":"Large"}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"has_multiple_variants":true,"variants":[{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","sku":"TEE-CC-S","barcode":"5901234123451","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Small"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:medium","sku":"TEE-CC-M","barcode":"5901234123468","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Medium"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:large","sku":"TEE-CC-L","barcode":"5901234123475","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Large"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"stock_tracking":"variant","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_modifiers":{"summary":"Product with modifiers","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Cheeseburger","description":"A juicy beef patty with melted cheese, lettuce, and tomato on a brioche bun.","default_price":{"amount":8500,"currency":"ZAR"},"default_barcode":"6009800000022","default_cost_price":{"amount":3200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Doneness","min_selections":1,"max_selections":1,"ordinal":0,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Medium-Rare","pricing_strategy":"free","is_selected_by_default":true,"ordinal":0},{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566aa","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Well-Done","pricing_strategy":"free","is_selected_by_default":false,"ordinal":1}]},{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","name":"Side Orders","min_selections":0,"max_selections":2,"ordinal":1,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566bb","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","type":"product","name":"Chips","pricing_strategy":"fixed_price","fixed_price":{"amount":2500,"currency":"ZAR"},"is_selected_by_default":false,"ordinal":0,"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:chips"}]}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}},"service":{"summary":"Service","value":{"type":"service","id":"1742394820001-a27d3f6e-4b18-4c92-9e51-2a8fbb4d31c7","name":"Men's Haircut","description":"A classic men's haircut and style finish, including a wash and blow-dry.","default_price":{"amount":25000,"currency":"ZAR"},"default_barcode":"6009800000039","default_cost_price":{"amount":8000,"currency":"ZAR"},"default_duration":30,"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1742394821447-c5f1a902-6d77-4f14-bbe2-09d2c4fa5e88","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"put":{"tags":["Items"],"summary":"Update an item","description":"Replace an item. The request carries every field, and `null` clears a value unless the field says otherwise.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"update_item_v1_items__item_id__put","security":[{"Bearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item.","title":"Item Id"},"description":"The unique identifier of the item."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateItemRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/ProductItem"},{"$ref":"#/components/schemas/ServiceItem"}],"discriminator":{"propertyName":"type","mapping":{"product":"#/components/schemas/ProductItem","service":"#/components/schemas/ServiceItem"}},"title":"Response Update Item V1 Items  Item Id  Put"},"examples":{"product":{"summary":"Product","value":{"type":"product","id":"1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef","name":"Flat White","description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","default_price":{"amount":3800,"currency":"ZAR"},"default_barcode":"6009800000015","default_cost_price":{"amount":1200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"item","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_variants":{"summary":"Product with variants","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Classic Cotton T-Shirt","description":"100% cotton crew-neck t-shirt with a relaxed fit, available in three sizes.","default_price":{"amount":19900,"currency":"ZAR"},"default_barcode":"5901234123444","default_cost_price":{"amount":8500,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[{"id":"1719321843217-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90","name":"Size","values":[{"name":"Small"},{"name":"Medium"},{"name":"Large"}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"has_multiple_variants":true,"variants":[{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","sku":"TEE-CC-S","barcode":"5901234123451","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Small"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:medium","sku":"TEE-CC-M","barcode":"5901234123468","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Medium"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"},{"id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:large","sku":"TEE-CC-L","barcode":"5901234123475","price":{"amount":19900,"currency":"ZAR"},"cost_price":{"amount":8500,"currency":"ZAR"},"is_enabled":true,"selected_options":[{"name":"Size","value":"Large"}],"modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"stock_tracking":"variant","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337"}},"product_with_modifiers":{"summary":"Product with modifiers","value":{"type":"product","id":"1719321840557-3f8a1d29-7b04-4e10-9c63-2d4f7e9a8b21","name":"Cheeseburger","description":"A juicy beef patty with melted cheese, lettuce, and tomato on a brioche bun.","default_price":{"amount":8500,"currency":"ZAR"},"default_barcode":"6009800000022","default_cost_price":{"amount":3200,"currency":"ZAR"},"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1719321841992-eaa9d3b6-1c47-4b8a-a4f1-8a7c61f0a3d4","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Doneness","min_selections":1,"max_selections":1,"ordinal":0,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Medium-Rare","pricing_strategy":"free","is_selected_by_default":true,"ordinal":0},{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566aa","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"note","name":"Well-Done","pricing_strategy":"free","is_selected_by_default":false,"ordinal":1}]},{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","name":"Side Orders","min_selections":0,"max_selections":2,"ordinal":1,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566bb","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455aa","type":"product","name":"Chips","pricing_strategy":"fixed_price","fixed_price":{"amount":2500,"currency":"ZAR"},"is_selected_by_default":false,"ordinal":0,"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:chips"}]}],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}},"service":{"summary":"Service","value":{"type":"service","id":"1742394820001-a27d3f6e-4b18-4c92-9e51-2a8fbb4d31c7","name":"Men's Haircut","description":"A classic men's haircut and style finish, including a wash and blow-dry.","default_price":{"amount":25000,"currency":"ZAR"},"default_barcode":"6009800000039","default_cost_price":{"amount":8000,"currency":"ZAR"},"default_duration":30,"is_taxable":true,"taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00"}],"images":[{"id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","type":"image","mime_type":"image/jpeg","url":"https://images.yoco.com/foo/bar.jpg","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"category_id":"1742394821447-c5f1a902-6d77-4f14-bbe2-09d2c4fa5e88","options":[],"has_multiple_variants":false,"variants":[],"stock_tracking":"none","modifier_groups":[],"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"delete":{"tags":["Items"],"summary":"Delete an item","description":"Delete an item\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"delete_item_v1_items__item_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the item.","title":"Item Id"},"description":"The unique identifier of the item."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/locations/":{"get":{"tags":["Locations"],"summary":"List locations","description":"List locations\n\n**Required scope: `business/locations:read`**","operationId":"list_locations_v1_locations__get","security":[{"Bearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/LocationStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Location_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","name":"Main Store","status":"active","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/locations/{location_id}":{"get":{"tags":["Locations"],"summary":"Fetch a location","description":"Fetch a location\n\n**Required scope: `business/locations:read`**","operationId":"fetch_location_v1_locations__location_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"location_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the location.","title":"Location Id"},"description":"The unique identifier of the location."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Location"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/media/":{"post":{"tags":["Media"],"summary":"Upload media","description":"Upload a JPEG, PNG, GIF or WebP image of up to 10 MB. Attach the returned media's `id` to a catalogue item, brand or category.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"upload_media_v1_media__post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/UploadMediaRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Media"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}}}}},"413":{"description":"Content Too Large","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"content_too_large":{"summary":"Content Too Large","value":{"type":"https://developer.yoco.com/docs/api/error-codes/content-too-large","title":"Content Too Large","detail":"The request content is larger than this resource accepts.","status":413,"code":"content_too_large"}}}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unsupported_media_type":{"summary":"Unsupported Media Type","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unsupported-media-type","title":"Unsupported Media Type","detail":"The request content is of a media type this resource does not accept.","status":415,"code":"unsupported_media_type"}}}}}}},"security":[{"Bearer":[]}]}},"/v1/modifier_groups/":{"get":{"tags":["Modifier Groups"],"summary":"List modifier groups","description":"List modifier groups\n\n**Required scope: `business/catalogue:read`**","operationId":"list_modifier_groups_v1_modifier_groups__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_ModifierGroup_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Side Orders","min_selections":0,"max_selections":2,"modifiers":[{"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","type":"product","name":"Chips","pricing_strategy":"fixed_price","fixed_price":{"amount":500,"currency":"ZAR"},"is_selected_by_default":false,"ordinal":1,"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"created_at":"2024-11-19T15:27:02+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"post":{"tags":["Modifier Groups"],"summary":"Create a modifier group","description":"Create a modifier group\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"create_modifier_group_v1_modifier_groups__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateModifierGroupRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifierGroup"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}}},"/v1/modifier_groups/{modifier_group_id}":{"get":{"tags":["Modifier Groups"],"summary":"Fetch a modifier group","description":"Fetch a modifier group\n\n**Required scope: `business/catalogue:read`**","operationId":"fetch_modifier_group_v1_modifier_groups__modifier_group_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"modifier_group_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the modifier group.","title":"Modifier Group Id"},"description":"The unique identifier of the modifier group."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifierGroup"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"put":{"tags":["Modifier Groups"],"summary":"Update a modifier group","description":"Replace a modifier group. The request carries every field, and `null` clears a value unless the field says otherwise.\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"update_modifier_group_v1_modifier_groups__modifier_group_id__put","security":[{"Bearer":[]}],"parameters":[{"name":"modifier_group_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the modifier group.","title":"Modifier Group Id"},"description":"The unique identifier of the modifier group."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateModifierGroupRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifierGroup"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Conflict"}}},"delete":{"tags":["Modifier Groups"],"summary":"Delete a modifier group","description":"Delete a modifier group\n\n**Required scopes: `business/catalogue:read`, `business/catalogue:write`**","operationId":"delete_modifier_group_v1_modifier_groups__modifier_group_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"modifier_group_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the modifier group.","title":"Modifier Group Id"},"description":"The unique identifier of the modifier group."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/orders/":{"post":{"tags":["Orders"],"summary":"Create an order","description":"Create an order\n\n**Required scopes: `business/orders:read`, `business/orders:write`**","operationId":"create_order_v1_orders__post","security":[{"Bearer":[]}],"parameters":[{"name":"Idempotency-Key","in":"header","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255,"pattern":"^[\\x20-\\x7E]+$"},{"type":"null"}],"description":"A key you generate, such as a UUID v4, to retry this request safely. A retry with the same key and body within 24 hours returns the first response instead of creating a second order. See [Idempotency](/docs/api/idempotency).\n\nThe API stores these first responses and returns them to a retry:\n\n- A success.\n- An HTTP 400 with code `validation` and no `errors` list.\n- An HTTP 404 with code `not_found`.\n- An HTTP 409 with code `conflict` for an `external_id` that's already in use.\n\nAny other response isn't stored, so a retry with the same key runs the request again.\n\nWhen a key is reused after it's freed, after 24 hours or after a response that isn't stored, the API looks up the order the first request created and returns it with `Idempotent-Replayed: true` instead of creating a second order. If the lookup doesn't find the order, a retry of an open order returns the same order without the header. A retry of a paid order returns an HTTP 409 with code `conflict`; retry it after a short delay with the same key.\n\nThe key and the order's `external_id` answer different questions:\n\n- The key tells you whether a request got through. It expires after 24 hours.\n- The `external_id` is your own identifier for the order. It's stored on the order and is unique within a channel on the business.","title":"Idempotency-Key"},"description":"A key you generate, such as a UUID v4, to retry this request safely. A retry with the same key and body within 24 hours returns the first response instead of creating a second order. See [Idempotency](/docs/api/idempotency).\n\nThe API stores these first responses and returns them to a retry:\n\n- A success.\n- An HTTP 400 with code `validation` and no `errors` list.\n- An HTTP 404 with code `not_found`.\n- An HTTP 409 with code `conflict` for an `external_id` that's already in use.\n\nAny other response isn't stored, so a retry with the same key runs the request again.\n\nWhen a key is reused after it's freed, after 24 hours or after a response that isn't stored, the API looks up the order the first request created and returns it with `Idempotent-Replayed: true` instead of creating a second order. If the lookup doesn't find the order, a retry of an open order returns the same order without the header. A retry of a paid order returns an HTTP 409 with code `conflict`; retry it after a short delay with the same key.\n\nThe key and the order's `external_id` answer different questions:\n\n- The key tells you whether a request got through. It expires after 24 hours.\n- The `external_id` is your own identifier for the order. It's stored on the order and is unique within a channel on the business."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}},"headers":{"Idempotent-Replayed":{"description":"`true` when the response replays an earlier request with the same `Idempotency-Key`: the response stored for it, or the order it created. Left out of a response the request produced itself. A retry can also return the order the first request created without this header.","schema":{"type":"string","enum":["true"]}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"Idempotent-Replayed":{"description":"`true` when the response replays an earlier request with the same `Idempotency-Key`: the response stored for it, or the order it created. Left out of a response the request produced itself. A retry can also return the order the first request created without this header.","schema":{"type":"string","enum":["true"]}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"Idempotent-Replayed":{"description":"`true` when the response replays an earlier request with the same `Idempotency-Key`: the response stored for it, or the order it created. Left out of a response the request produced itself. A retry can also return the order the first request created without this header.","schema":{"type":"string","enum":["true"]}}},"description":"Not Found"},"409":{"content":{"application/json":{"examples":{"conflict":{"summary":"Conflict","value":{"type":"https://developer.yoco.com/docs/api/error-codes/conflict","title":"Conflict","detail":"The request conflicts with the current state of the resource.","status":409,"code":"conflict"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"headers":{"Idempotent-Replayed":{"description":"`true` when the response replays an earlier request with the same `Idempotency-Key`: the response stored for it, or the order it created. Left out of a response the request produced itself. A retry can also return the order the first request created without this header.","schema":{"type":"string","enum":["true"]}}},"description":"Conflict"},"503":{"content":{"application/json":{"examples":{"service_unavailable":{"summary":"Service Unavailable","value":{"type":"https://developer.yoco.com/docs/api/error-codes/service-unavailable","title":"Service Unavailable","detail":"The service is temporarily unavailable. Retry the request later.","status":503,"code":"service_unavailable"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Service Unavailable"}}},"get":{"tags":["Orders"],"summary":"List orders","description":"List orders\n\n**Required scope: `business/orders:read`**","operationId":"list_orders_v1_orders__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"closed_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Closed At  Gte"},"description":"The min closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"closed_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Closed At  Lte"},"description":"The max closed date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/OrderStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."},{"name":"location_id","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$"}},{"type":"null"}],"description":"A list of location ids to filter on. Pass \"null\" to include orders without a location.","title":"Location Id"},"description":"A list of location ids to filter on. Pass \"null\" to include orders without a location."},{"name":"channel","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string","minLength":1,"maxLength":50}},{"type":"null"}],"description":"A list of channels to filter on. A channel is the originating integration's own lowercase slug (for example `uber_eats`), and each value is trimmed and lowercased before it is matched. Matches orders originating from any of the supplied channels. Pass \"null\" to include orders without a channel.","example":["uber_eats","null"],"title":"Channel"},"description":"A list of channels to filter on. A channel is the originating integration's own lowercase slug (for example `uber_eats`), and each value is trimmed and lowercased before it is matched. Matches orders originating from any of the supplied channels. Pass \"null\" to include orders without a channel."},{"name":"external_id","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"The originating integration's own identifier for the order, trimmed and then matched exactly. Pass `channel` alongside it to narrow to the single order that channel created, since an external id is only unique within a channel.","example":"UE-8843102","title":"External Id"},"description":"The originating integration's own identifier for the order, trimmed and then matched exactly. Pass `channel` alongside it to narrow to the single order that channel created, since an external id is only unique within a channel."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Order_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","display_name":"Order #10542623","order_number":"10542623","name":"Table 42","currency":"ZAR","note":"This is a very important table.","location_id":"93e230af-afc5-4839-a471-ba52f71f9447","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","channel":"uber_eats","external_id":"UE-8843102","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","closed_at":"2024-11-19T16:27:23+00:00","status":"completed","amounts":{"gross_amount":{"amount":16680,"currency":"ZAR"},"discount_amount":{"amount":2780,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"},"net_amount":{"amount":16400,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"service_charge_amount":{"amount":2500,"currency":"ZAR"}},"line_items":[{"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6","name":"Men's Funky Blue T-Shirt - Medium","quantity":"1.000","item_type":"product","note":"This is an optional note related to this item in the order.","unit_price":{"amount":13900,"currency":"ZAR"},"total_price":{"amount":13900,"currency":"ZAR"},"discount_amount":{"amount":2780,"currency":"ZAR"},"net_amount":{"amount":25020,"currency":"ZAR"},"applied_taxes":[{"name":"VAT","type":"inclusive","percentage":"15.00","tax_amount":{"amount":3000,"currency":"ZAR"},"scope":"line_item"}],"applied_discounts":[{"name":"Item Discount","type":"fixed_percentage","percentage":"10.00","discount_amount":{"amount":3000,"currency":"ZAR"},"scope":"order"}],"modifiers":[{"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","group_name":"Side Orders","group_ordinal":1,"name":"Chips","variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","price":{"amount":500,"currency":"ZAR"},"ordinal":1}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9"}],"total_taxes":[{"name":"VAT","type":"inclusive","percentage":"15.00","tax_amount":{"amount":3000,"currency":"ZAR"},"scope":"line_item"}],"applied_discounts":[{"name":"Item Discount","type":"fixed_percentage","percentage":"10.00","discount_amount":{"amount":3000,"currency":"ZAR"},"scope":"order"}],"service_charges":[{"id":"1585232943682-b3f0a1c2-9d4e-4f6a-8b1c-2d3e4f5a6b7c","name":"Delivery fee","amount":{"amount":2500,"currency":"ZAR"}}],"payments":[{"id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","client_transaction_id":"5f29b4cf-5650-4c71-b7e5-f70eb892e55f","display_name":"Payment receipt #491352","receipt_number":"491352","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this payment.","amount_excl_tip":{"amount":25000,"currency":"ZAR"},"tip_amount":{"amount":2500,"currency":"ZAR"},"service_charge_amount":{"amount":1250,"currency":"ZAR"},"total_amount":{"amount":27500,"currency":"ZAR"},"refunded_amount":{"amount":0,"currency":"ZAR"},"status":"approved","payment_method":"card","payment_source":"payment_link","refunds":[{"id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","client_transaction_id":"rfd_765fde5ded7bxd","display_name":"Refund receipt #491352","receipt_number":"491352","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this refund.","total_amount":{"amount":4500,"currency":"ZAR"},"status":"approved","processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"processed_at":"2024-11-20T16:27:23+00:00","payment_method":"card","refunded_processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"refund_type":"auth_reversal"}],"checkout_id":"ch_J2xYWl4m7B6DsKAPCM9SRDEd","external_id":"order-123","card_machine_id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4"}],"refunds":[{"id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","client_transaction_id":"rfd_765fde5ded7bxd","display_name":"Refund receipt #491352","receipt_number":"491352","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this refund.","total_amount":{"amount":4500,"currency":"ZAR"},"status":"approved","processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"processed_at":"2024-11-20T16:27:23+00:00","payment_method":"card","refunded_processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"refund_type":"auth_reversal"}],"returns":[{"returned_line_items":[{"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6","name":"Men's Funky Blue T-Shirt - Medium","quantity":"1.000","item_type":"product","note":"This is an optional note related to this item in the order.","unit_price":{"amount":13900,"currency":"ZAR"},"total_price":{"amount":13900,"currency":"ZAR"},"discount_amount":{"amount":2780,"currency":"ZAR"},"net_amount":{"amount":25020,"currency":"ZAR"},"applied_taxes":[{"name":"VAT","type":"inclusive","percentage":"15.00","tax_amount":{"amount":3000,"currency":"ZAR"},"scope":"line_item"}],"applied_discounts":[{"name":"Item Discount","type":"fixed_percentage","percentage":"10.00","discount_amount":{"amount":3000,"currency":"ZAR"},"scope":"order"}],"modifiers":[{"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","group_name":"Side Orders","group_ordinal":1,"name":"Chips","variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small","price":{"amount":500,"currency":"ZAR"},"ordinal":1}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9"}],"returned_total_taxes":[{"name":"VAT","type":"inclusive","percentage":"15.00","tax_amount":{"amount":3000,"currency":"ZAR"},"scope":"line_item"}],"returned_applied_discounts":[{"name":"Item Discount","type":"fixed_percentage","percentage":"10.00","discount_amount":{"amount":3000,"currency":"ZAR"},"scope":"order"}],"source_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","amounts":{"gross_amount":{"amount":16680,"currency":"ZAR"},"discount_amount":{"amount":2780,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"},"net_amount":{"amount":13900,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"service_charge_amount":{"amount":0,"currency":"ZAR"}}}]}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/orders/{order_id}":{"get":{"tags":["Orders"],"summary":"Fetch an order","description":"Fetch an order\n\n**Required scope: `business/orders:read`**","operationId":"fetch_order_v1_orders__order_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"order_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the order.","title":"Order Id"},"description":"The unique identifier of the order."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Order"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payment_links/":{"post":{"tags":["Payment links"],"summary":"Create a payment link","description":"Create a payment link\n\n**Required scopes: `business/orders:read`, `business/orders:write`**","operationId":"create_payment_link_v1_payment_links__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentLinkRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLink"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"get":{"tags":["Payment links"],"summary":"List payment links","description":"List payment links\n\n**Required scope: `business/orders:read`**","operationId":"list_payment_links_v1_payment_links__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PaymentLinkStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_PaymentLink_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","url":"https://pay.yoco.com/r/dRggEC","customer_reference":"Peter Parker","customer_description":"This description is visible to the customer on the payment page.","status":"pending","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payment_links/{payment_link_id}":{"get":{"tags":["Payment links"],"summary":"Fetch a payment link","description":"Fetch a payment link\n\n**Required scope: `business/orders:read`**","operationId":"fetch_payment_link_v1_payment_links__payment_link_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"payment_link_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the payment link.","title":"Payment Link Id"},"description":"The unique identifier of the payment link."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentLink"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"delete":{"tags":["Payment links"],"summary":"Delete a payment link","description":"Delete a payment link\n\n**Required scopes: `business/orders:read`, `business/orders:write`**","operationId":"delete_payment_link_v1_payment_links__payment_link_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"payment_link_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the payment link.","title":"Payment Link Id"},"description":"The unique identifier of the payment link."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payments/":{"get":{"tags":["Payments"],"summary":"List payments","description":"List payments\n\n**Required scope: `business/orders:read`**","operationId":"list_payments_v1_payments__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PaymentStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Payment_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","client_transaction_id":"5f29b4cf-5650-4c71-b7e5-f70eb892e55f","display_name":"Payment receipt #491352","receipt_number":"491352","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this payment.","amount_excl_tip":{"amount":25000,"currency":"ZAR"},"tip_amount":{"amount":2500,"currency":"ZAR"},"service_charge_amount":{"amount":1250,"currency":"ZAR"},"total_amount":{"amount":27500,"currency":"ZAR"},"refunded_amount":{"amount":0,"currency":"ZAR"},"status":"approved","payment_method":"card","payment_source":"payment_link","refunds":[{"id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","client_transaction_id":"rfd_765fde5ded7bxd","display_name":"Refund receipt #491352","receipt_number":"491352","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this refund.","total_amount":{"amount":4500,"currency":"ZAR"},"status":"approved","processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"processed_at":"2024-11-20T16:27:23+00:00","payment_method":"card","refunded_processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"refund_type":"auth_reversal"}],"checkout_id":"ch_J2xYWl4m7B6DsKAPCM9SRDEd","external_id":"order-123","card_machine_id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payments/{payment_id}":{"get":{"tags":["Payments"],"summary":"Fetch a payment","description":"Fetch a payment\n\n**Required scope: `business/orders:read`**","operationId":"fetch_payment_v1_payments__payment_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the payment.","title":"Payment Id"},"description":"The unique identifier of the payment."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payment"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payouts/":{"get":{"tags":["Payouts"],"summary":"List payouts","description":"List payouts\n\n**Required scope: `business/payouts:read`**","operationId":"list_payouts_v1_payouts__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/PayoutStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Payout_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1744288539-57db0a32-3cae-40af-a328-b22a09cfcb94","status":"paid","payout_type":"standard","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","gross_amount":{"amount":12000,"currency":"ZAR"},"capital_repayment_amount":{"amount":250,"currency":"ZAR"},"fee_amount":{"amount":350,"currency":"ZAR"},"net_amount":{"amount":11400,"currency":"ZAR"},"payout_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}]}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payouts/{payout_id}":{"get":{"tags":["Payouts"],"summary":"Fetch a payout","description":"Fetch a payout\n\n**Required scope: `business/payouts:read`**","operationId":"fetch_payout_v1_payouts__payout_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"payout_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the payout.","title":"Payout Id"},"description":"The unique identifier of the payout."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Payout"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/payouts/{payout_id}/payout_entries":{"get":{"tags":["Payouts"],"summary":"List payout entries","description":"List payout entries\n\n**Required scope: `business/payouts:read`**","operationId":"list_payout_entries_v1_payouts__payout_id__payout_entries_get","security":[{"Bearer":[]}],"parameters":[{"name":"payout_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the payout.","title":"Payout Id"},"description":"The unique identifier of the payout."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_PayoutEntry_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1744289052-a70682ae-7376-404c-9859-3aa100322fa0","client_transaction_id":"rfd_765fde5ded7bxd","payout_id":"1744288539-57db0a32-3cae-40af-a328-b22a09cfcb94","type":"payment","gross_amount":{"amount":12000,"currency":"ZAR"},"capital_repayment_amount":{"amount":250,"currency":"ZAR"},"fee_amount":{"amount":350,"currency":"ZAR"},"net_amount":{"amount":11400,"currency":"ZAR"}}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/refunds/":{"get":{"tags":["Refunds"],"summary":"List refunds","description":"List refunds\n\n**Required scope: `business/orders:read`**","operationId":"list_refunds_v1_refunds__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"$ref":"#/components/schemas/RefundStatus"}},{"type":"null"}],"description":"A list of statuses to filter on.","title":"Status"},"description":"A list of statuses to filter on."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Refund_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","client_transaction_id":"rfd_765fde5ded7bxd","display_name":"Refund receipt #491352","receipt_number":"491352","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00","currency":"ZAR","note":"This is a note on this refund.","total_amount":{"amount":4500,"currency":"ZAR"},"status":"approved","processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"processed_at":"2024-11-20T16:27:23+00:00","payment_method":"card","refunded_processing_fees":[{"type":"initial","amount":{"amount":27800,"currency":"ZAR"}}],"refund_type":"auth_reversal"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/refunds/{refund_id}":{"get":{"tags":["Refunds"],"summary":"Fetch a refund","description":"Fetch a refund\n\n**Required scope: `business/orders:read`**","operationId":"fetch_refund_v1_refunds__refund_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"refund_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the refund.","title":"Refund Id"},"description":"The unique identifier of the refund."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Refund"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/staff/":{"get":{"tags":["Staff"],"summary":"List staff members","description":"List staff members\n\n**Required scope: `business/staff:read`**","operationId":"list_staff_v1_staff__get","security":[{"Bearer":[]}],"parameters":[{"name":"created_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Gte"},"description":"The min created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"created_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Created At  Lte"},"description":"The max created date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__gte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Gte"},"description":"The min updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"updated_at__lte","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days.","example":"2024-11-19T15:27:02+00:00","title":"Updated At  Lte"},"description":"The max updated date and time in ISO 8601 format. If only one bound is provided, the other is automatically set 31 days away, or at the edge of the supported date range if that is closer (e.g. supplying only `__gte=2024-11-01T00:00:00Z` sets `__lte=2024-12-02T00:00:00Z`). When both bounds are provided, `__gte` must be on or before `__lte`, and the range may not exceed 31 days."},{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."},{"name":"status","in":"query","required":false,"schema":{"anyOf":[{"$ref":"#/components/schemas/StaffStatus"},{"type":"null"}],"description":"Filter staff by whether they are currently active in the business. When omitted, both active and inactive (removed) staff are returned so that historical records referencing a removed staff member can still be resolved. Pass `active` or `inactive` to narrow the list.","title":"Status"},"description":"Filter staff by whether they are currently active in the business. When omitted, both active and inactive (removed) staff are returned so that historical records referencing a removed staff member can still be resolved. Pass `active` or `inactive` to narrow the list."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Staff_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","staff_number":"1234","role":"manager","status":"active","first_name":"Jane","last_name":"Doe","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T15:27:02+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/staff/{staff_id}":{"get":{"tags":["Staff"],"summary":"Fetch a staff member","description":"Fetch a staff member\n\n**Required scope: `business/staff:read`**","operationId":"fetch_staff_v1_staff__staff_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"staff_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the staff member.","title":"Staff Id"},"description":"The unique identifier of the staff member."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Staff"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/taxes/":{"get":{"tags":["Taxes"],"summary":"List taxes","description":"List taxes\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"list_taxes_v1_taxes__get","security":[{"Bearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_Tax_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","type":"inclusive","percentage":"15.00","is_default":true,"created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T16:27:23+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/taxes/{tax_id}":{"get":{"tags":["Taxes"],"summary":"Fetch a tax","description":"Fetch a tax\n\n**Required scope: `business/catalogue:read`**\n\n**Deprecated alias:** `business/products:read` (still accepted, will be removed in a future release)","operationId":"fetch_tax_v1_taxes__tax_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"tax_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":201,"pattern":"^[A-Za-z0-9:-]+$","description":"The unique identifier of the tax.","title":"Tax Id"},"description":"The unique identifier of the tax."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Tax"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webhooks/subscriptions/":{"post":{"tags":["Webhooks"],"summary":"Create webhook subscription","description":"Create webhook subscription\n\n**Required scopes: `application/webhooks:read`, `application/webhooks:write`**","operationId":"create_webhook_subscription_v1_webhooks_subscriptions__post","security":[{"Bearer":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebhookSubscriptionRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"get":{"tags":["Webhooks"],"summary":"List webhook subscriptions","description":"List webhook subscriptions\n\n**Required scope: `application/webhooks:read`**","operationId":"list_webhook_subscriptions_v1_webhooks_subscriptions__get","security":[{"Bearer":[]}],"parameters":[{"name":"cursor","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1,"maxLength":255},{"type":"null"}],"description":"A pagination cursor from where results should start being fetched.","title":"Cursor"},"description":"A pagination cursor from where results should start being fetched."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"The maximum number of results to return.","format":"int32","default":50,"title":"Limit"},"description":"The maximum number of results to return."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponse_WebhookSubscription_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"id":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","name":"Example Webhook Subscription","enabled":true,"event_types":["payment.created"],"notification_url":"https://webhook.site/1d9d0c3c-c0f9-4def-8cf1-99efb5931eca","secret":"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD","created_at":"2024-11-19T15:27:02+00:00","updated_at":"2024-11-19T15:27:02+00:00"}],"next_cursor":"1323935095007282836"}}}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webhooks/subscriptions/{subscription_id}":{"get":{"tags":["Webhooks"],"summary":"Fetch a webhook subscription","description":"Fetch a webhook subscription\n\n**Required scope: `application/webhooks:read`**","operationId":"fetch_webhook_subscription_v1_webhooks_subscriptions__subscription_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier of the subscription.","title":"Subscription Id"},"description":"The unique identifier of the subscription."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"delete":{"tags":["Webhooks"],"summary":"Delete a webhook subscription","description":"Delete a webhook subscription\n\n**Required scopes: `application/webhooks:read`, `application/webhooks:write`**","operationId":"delete_webhook_subscription_v1_webhooks_subscriptions__subscription_id__delete","security":[{"Bearer":[]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier of the subscription.","title":"Subscription Id"},"description":"The unique identifier of the subscription."}],"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}},"patch":{"tags":["Webhooks"],"summary":"Update a webhook subscription","description":"Update a webhook subscription\n\n**Required scopes: `application/webhooks:read`, `application/webhooks:write`**","operationId":"update_webhook_subscription_v1_webhooks_subscriptions__subscription_id__patch","security":[{"Bearer":[]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier of the subscription.","title":"Subscription Id"},"description":"The unique identifier of the subscription."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateWebhookSubscriptionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebhookSubscription"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webhooks/subscriptions/{subscription_id}/secret":{"post":{"tags":["Webhooks"],"summary":"Rotate the secret for a webhook subscription","description":"Rotate the secret for a webhook subscription\n\n**Required scopes: `application/webhooks:read`, `application/webhooks:write`**","operationId":"rotate_webhook_subscription_secret_v1_webhooks_subscriptions__subscription_id__secret_post","security":[{"Bearer":[]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier of the subscription.","title":"Subscription Id"},"description":"The unique identifier of the subscription."}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RotateWebhookSubscriptionSecretResponse"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webhooks/subscriptions/{subscription_id}/test":{"post":{"tags":["Webhooks"],"summary":"Send a test webhook event for a subscription","description":"Send a test webhook event for a subscription\n\n**Required scope: `application/webhooks:write`**","operationId":"send_test_webhook_event_v1_webhooks_subscriptions__subscription_id__test_post","security":[{"Bearer":[]}],"parameters":[{"name":"subscription_id","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":100,"description":"The unique identifier of the subscription.","title":"Subscription Id"},"description":"The unique identifier of the subscription."}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestWebhookEventRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SendTestWebhookEventResponse"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webhooks/events/":{"get":{"tags":["Webhooks"],"summary":"List webhook event definitions","description":"List webhook event definitions","operationId":"list_webhook_event_definitions_v1_webhooks_events__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListResponse_WebhookEventDefinition_"},"examples":{"retrieved":{"summary":"Retrieved","value":{"data":[{"event_type":"payment.created","name":"Payment Created","description":"A notification sent when a payment is created."}]}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}}}}}},"security":[{"Bearer":[]}]}},"/v1/webpos/":{"post":{"tags":["Web POS"],"summary":"Create a Web POS device","description":"Create a Web POS device. Web POS devices represent a station/browser instance/device, for example 'Reception', 'Back Office', 'Joe iPad', etc.\n\n**Required scopes: `business/webpos:read`, `business/webpos:write`**","operationId":"create_web_pos_device_v1_webpos__post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebPOSDeviceRequest"}}},"required":true},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPOSDevice"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"},"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}}}}}},"security":[{"Bearer":[]}]}},"/v1/webpos/{webpos_device_id}":{"get":{"tags":["Web POS"],"summary":"Fetch a Web POS device","description":"Fetch a Web POS device\n\n**Required scope: `business/webpos:read`**","operationId":"fetch_web_pos_device_v1_webpos__webpos_device_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"webpos_device_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The unique ID of the Web POS device."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPOSDevice"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webpos/{webpos_device_id}/payments":{"post":{"tags":["Web POS"],"summary":"Create a Web POS payment","description":"Create a Web POS payment. This is used to initiate a new payment acceptance process.\n\n**Required scopes: `business/webpos:read`, `business/webpos:write`**","operationId":"create_web_pos_payment_v1_webpos__webpos_device_id__payments_post","security":[{"Bearer":[]}],"parameters":[{"name":"webpos_device_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The unique ID of the Web POS device."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWebPOSPaymentRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPOSPayment"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/webpos/{webpos_device_id}/payments/{payment_id}":{"get":{"tags":["Web POS"],"summary":"Fetch a Web POS payment","description":"Fetch a Web POS payment.\n\n**Required scope: `business/webpos:read`**","operationId":"fetch_web_pos_payment_v1_webpos__webpos_device_id__payments__payment_id__get","security":[{"Bearer":[]}],"parameters":[{"name":"webpos_device_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The unique ID of the Web POS device."}},{"name":"payment_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"The unique ID of the Web POS payment."}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/WebPOSPayment"}}}},"400":{"content":{"application/json":{"examples":{"validation":{"summary":"Validation Error","value":{"type":"https://developer.yoco.com/docs/api/error-codes/validation","title":"Validation Error","detail":"The request contains one or more validation errors.","status":400,"code":"validation"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Bad Request"},"401":{"content":{"application/json":{"examples":{"unauthorized":{"summary":"Unauthorized","value":{"type":"https://developer.yoco.com/docs/api/error-codes/unauthorized","title":"Unauthorized","detail":"The provided credentials are invalid.","status":401,"code":"unauthorized"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Unauthorized"},"403":{"content":{"application/json":{"examples":{"forbidden":{"summary":"Forbidden","value":{"type":"https://developer.yoco.com/docs/api/error-codes/forbidden","title":"Forbidden","detail":"You do not have permission to access this resource.","status":403,"code":"forbidden"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Forbidden"},"404":{"content":{"application/json":{"examples":{"not_found":{"summary":"Not Found","value":{"type":"https://developer.yoco.com/docs/api/error-codes/not-found","title":"Not Found","detail":"The requested resource does not exist.","status":404,"code":"not_found"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Not Found"},"429":{"content":{"application/json":{"examples":{"rate_limited":{"summary":"Too Many Requests","value":{"type":"https://developer.yoco.com/docs/api/error-codes/rate-limited","title":"Too Many Requests","detail":"You have exceeded the rate limit for this API end-point.","status":429,"code":"rate_limited"}}},"schema":{"$ref":"#/components/schemas/ErrorResponse"}}},"description":"Too Many Requests"}}}},"/v1/oauth2/token_info":{"get":{"tags":["OAuth 2"],"summary":"Get token info","description":"Get token info","operationId":"get_token_info_v1_oauth2_token_info_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AuthorizedBusinessDetailsResponse"}}}}},"security":[{"Bearer":[]}]}}},"webhooks":{"item_category.created":{"post":{"tags":["Webhook Events"],"summary":"Item Category Created","description":"A notification sent when an item category is created.\n\n**Required scope: `business/products:read`**","operationId":"item_category.created","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategoryCreated"}}},"required":true}}},"item_category.deleted":{"post":{"tags":["Webhook Events"],"summary":"Item Category Deleted","description":"A notification sent when an item category is deleted.\n\n**Required scope: `business/products:read`**","operationId":"item_category.deleted","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategoryDeleted"}}},"required":true}}},"item_category.updated":{"post":{"tags":["Webhook Events"],"summary":"Item Category Updated","description":"A notification sent when an item category is updated.\n\n**Required scope: `business/products:read`**","operationId":"item_category.updated","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCategoryUpdated"}}},"required":true}}},"item.created":{"post":{"tags":["Webhook Events"],"summary":"Item Created","description":"A notification sent when an item is created.\n\n**Required scope: `business/products:read`**","operationId":"item.created","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemCreated"}}},"required":true}}},"item.deleted":{"post":{"tags":["Webhook Events"],"summary":"Item Deleted","description":"A notification sent when an item is deleted.\n\n**Required scope: `business/products:read`**","operationId":"item.deleted","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemDeleted"}}},"required":true}}},"item.updated":{"post":{"tags":["Webhook Events"],"summary":"Item Updated","description":"A notification sent when an item is updated.\n\n**Required scope: `business/products:read`**","operationId":"item.updated","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemUpdated"}}},"required":true}}},"order.cancelled":{"post":{"tags":["Webhook Events"],"summary":"Order Cancelled","description":"A notification sent when an order is cancelled.\n\n**Required scope: `business/orders:read`**","operationId":"order.cancelled","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCancelled"}}},"required":true}}},"order.completed":{"post":{"tags":["Webhook Events"],"summary":"Order Completed","description":"A notification sent when an order is closed (fully paid).\n\n**Required scope: `business/orders:read`**","operationId":"order.completed","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCompleted"}}},"required":true}}},"order.created":{"post":{"tags":["Webhook Events"],"summary":"Order Created","description":"A notification sent when a new order is opened.\n\n**Required scope: `business/orders:read`**","operationId":"order.created","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderCreated"}}},"required":true}}},"order.updated":{"post":{"tags":["Webhook Events"],"summary":"Order Updated","description":"A notification sent when an order is updated — line items added, changed, or voided; or when the order is saved or transferred.\n\n**Required scope: `business/orders:read`**","operationId":"order.updated","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderUpdated"}}},"required":true}}},"payment.created":{"post":{"tags":["Webhook Events"],"summary":"Payment Created","description":"A notification sent when a payment is created.\n\n**Required scope: `business/orders:read`**","operationId":"payment.created","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentCreated"}}},"required":true}}},"payment.refunded":{"post":{"tags":["Webhook Events"],"summary":"Payment Refunded","description":"A notification sent when a payment is refunded.\n\n**Required scope: `business/orders:read`**","operationId":"payment.refunded","parameters":[{"description":"An HMAC signature of the payload used to verify the webhook came from Yoco.","required":true,"schema":{"type":"string","title":"Webhook-Signature","description":"An HMAC signature of the payload used to verify the webhook came from Yoco."},"name":"webhook-signature","in":"header"}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRefunded"}}},"required":true}}}},"components":{"schemas":{"AttachItemModifierGroupRequest":{"properties":{"id":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$","title":"Id","description":"The unique identifier of the modifier group."},"ordinal":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Ordinal","description":"The position of the group among the item's modifier groups. Lower values appear first. The response returns the position Yoco stores, which keeps the order but can differ from the value sent."}},"type":"object","required":["id","ordinal"],"title":"AttachItemModifierGroupRequest","description":"`AttachItemModifierGroupRequest` attaches an existing modifier group to an item.","example":{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","ordinal":0}},"AuthorizedBusinessDetailsResponse":{"properties":{"business_id":{"type":"string","title":"Business Id","description":"Business id of the authorized business."},"business_name":{"type":"string","title":"Business Name","description":"Business name of the authorized business."}},"type":"object","required":["business_id","business_name"],"title":"AuthorizedBusinessDetailsResponse","example":{"business_id":"macs_burger_joint_2","business_name":"Macs Burger Joint"}},"CapitalAdvance":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the Capital advance."},"business_id":{"type":"string","title":"Business Id","description":"The unique identifier of the business this advance is for."},"provider_name":{"type":"string","title":"Provider Name","description":"The name of the Capital provider."},"repayment_rate":{"type":"string","title":"Repayment Rate","description":"The repayment rate as a decimal (e.g., 0.1 for 10%)."},"principal_amount":{"$ref":"#/components/schemas/Money","description":"The principal amount of the advance."},"total_payable_amount":{"$ref":"#/components/schemas/Money","description":"The total amount payable for the advance."},"total_paid_amount":{"$ref":"#/components/schemas/Money","description":"The total amount already paid towards the advance."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The advance creation date and time in ISO 8601 format."}},"type":"object","required":["id","business_id","provider_name","repayment_rate","principal_amount","total_payable_amount","total_paid_amount","created_at"],"title":"CapitalAdvance","example":{"business_id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","created_at":"2025-09-01T08:28:17.367000Z","id":"b1094ef1-c8c0-4a3e-9b9e-3f5786f72f54","principal_amount":{"amount":15000000,"currency":"ZAR"},"provider_name":"Yoco Capital","repayment_rate":"0.1","total_paid_amount":{"amount":10000000,"currency":"ZAR"},"total_payable_amount":{"amount":28400000,"currency":"ZAR"}}},"CapitalOffer":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the Capital offer."},"business_id":{"type":"string","title":"Business Id","description":"The unique identifier of the business this offer is for."},"provider_name":{"type":"string","title":"Provider Name","description":"The name of the Capital provider making the offer."},"max_principal_amount":{"$ref":"#/components/schemas/Money","description":"The max amount being offered to the merchant."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The offer creation date and time in ISO 8601 format."},"expires_at":{"type":"string","format":"date-time","title":"Expires At","description":"The offer expiration date and time in ISO 8601 format."}},"type":"object","required":["id","business_id","provider_name","max_principal_amount","created_at","expires_at"],"title":"CapitalOffer","example":{"business_id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","created_at":"2024-11-19T15:27:02+00:00","expires_at":"2024-12-19T15:27:02+00:00","id":"1748253969559-12951c6c-8033-44ee-ba87-539232f6fac9","max_principal_amount":{"amount":5000000,"currency":"ZAR"},"provider_name":"Yoco Capital"}},"CardDetails":{"properties":{"scheme":{"type":"string","title":"Scheme","description":"The card issuing network."},"masked_pan":{"type":"string","title":"Masked Pan","description":"Masked representation of the cardholder's primary account number."},"pan_entry_mode":{"anyOf":[{"$ref":"#/components/schemas/PanEntryMode"},{"type":"null"}],"description":"Input method the cardholder used (eg. tapped or inserted their card)."},"cardholder_verification_method":{"anyOf":[{"$ref":"#/components/schemas/CardholderVerificationMethod"},{"type":"null"}],"description":"How the cardholder was verified (eg. entered a pin)."}},"type":"object","required":["scheme","masked_pan","pan_entry_mode","cardholder_verification_method"],"title":"CardDetails","example":{"cardholder_verification_method":"online_pin","masked_pan":"441595******4874","pan_entry_mode":"contactless_icc","scheme":"visa"}},"CardMachine":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the card machine."},"nickname":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Nickname","description":"A human-friendly name given to the card machine, if one has been set."},"serial_number":{"type":"string","title":"Serial Number","description":"The serial number of the card machine."},"stocked_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Stocked At","description":"The date and time the card machine entered stock in ISO 8601 format. `null` when the stock date is not known."},"allocation":{"$ref":"#/components/schemas/CardMachineAllocation","description":"The card machine's allocation to the business."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The card machine creation date and time in ISO 8601 format."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The date and time the card machine was last modified in ISO 8601 format."}},"type":"object","required":["id","nickname","serial_number","stocked_at","allocation","created_at","updated_at"],"title":"CardMachine","example":{"allocation":{"allocated_at":"2024-03-15T09:12:44+02:00","condition":"refurbished"},"created_at":"2024-11-19T15:27:02+00:00","id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","nickname":"Front counter","serial_number":"S1F2102000123","stocked_at":"2024-02-01T00:00:00+02:00","updated_at":"2024-11-19T16:27:23+00:00"}},"CardMachineAllocation":{"properties":{"allocated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Allocated At","description":"The date and time the card machine was allocated to the business in ISO 8601 format. `null` when the allocation date is not known."},"condition":{"anyOf":[{"$ref":"#/components/schemas/CardMachineCondition"},{"type":"null"}],"description":"The condition of the card machine when it was allocated to the business, `new` or `refurbished`. `null` when the condition is not known."}},"type":"object","required":["allocated_at","condition"],"title":"CardMachineAllocation","example":{"allocated_at":"2024-03-15T09:12:44+02:00","condition":"refurbished"}},"CardMachineCondition":{"type":"string","enum":["new","refurbished"],"title":"CardMachineCondition"},"CardholderVerificationMethod":{"type":"string","enum":["approve_cvm_processing","failed","no_cvm_performed","offline_enciphered_pin","offline_enciphered_pin_and_signature","offline_plain_text_pin","offline_plain_text_pin_and_signature","online_pin","paper_based_signature_only"],"title":"CardholderVerificationMethod"},"CreateItemBrandRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the brand. Leading and trailing whitespace is removed, and the name that remains must be 1 to 255 characters long, and unique among the business's brands."},"description":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Description","description":"A description of the brand. Leading and trailing whitespace is removed, and the description that remains must be 1 to 255 characters long. Leave it out, or send `null`, for no description."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The `id` of the brand's image, a media item uploaded with `POST /v1/media/`. Leave it out, or send `null`, for no image."}},"type":"object","required":["name"],"title":"CreateItemBrandRequest","example":{"description":"Everyday products, built to last.","image_id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","name":"Acme"}},"CreateItemCategoryRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the category. Leading and trailing whitespace is removed, and the name that remains must be 1 to 255 characters long, and unique among the business's categories."},"description":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Description","description":"A description of the category. Leading and trailing whitespace is removed, and the description that remains must be 1 to 255 characters long. Leave it out, or send `null`, for no description."},"parent_category_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Parent Category Id","description":"The unique identifier of the parent category. The parent must be another category of the business. Leave it out, or send `null`, for a category with no parent."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The `id` of a media item uploaded with `POST /v1/media/`, shown as the image of the category. Leave it out, or send `null`, for a category with no image."}},"type":"object","required":["name"],"title":"CreateItemCategoryRequest","example":{"description":"A home for all our beverages.","image_id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","name":"Beverages","parent_category_id":"1757511225824-ab79f3ee-5a21-4bca-a060-ef27d9aae788"}},"CreateItemLocationAvailabilityRequest":{"properties":{"is_available_at_all_locations":{"type":"boolean","title":"Is Available At All Locations","description":"Whether the item or variant is available at every location. When `true`, `excluded_location_ids` lists the exceptions. When `false`, `included_location_ids` lists the only locations that sell it."},"included_location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"title":"Included Location Ids","description":"The unique identifiers of the only locations that sell the item or variant. Must be empty when `is_available_at_all_locations` is `true`."},"excluded_location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"title":"Excluded Location Ids","description":"The unique identifiers of the locations that do not sell the item or variant. Must be empty when `is_available_at_all_locations` is `false`."}},"type":"object","required":["is_available_at_all_locations"],"title":"CreateItemLocationAvailabilityRequest","description":"`CreateItemLocationAvailabilityRequest` carries the location availability of a new item or variant. A\nlocation list left out of the request is stored empty.","example":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true}},"CreateItemOptionRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the option, e.g. `Size`."},"values":{"items":{"$ref":"#/components/schemas/CreateItemOptionValueRequest"},"type":"array","maxItems":100,"minItems":1,"title":"Values","description":"The values the option can take, e.g. `Small` and `Large`."},"id":{"type":"null","title":"Id","description":"Must be `null` or left out: a new record has no `id` yet."}},"type":"object","required":["name","values"],"title":"CreateItemOptionRequest","description":"`CreateItemOptionRequest` carries a new option. It cannot carry an `id`.","example":{"name":"Size","values":[{"name":"Small"},{"name":"Large"}]}},"CreateItemOptionValueRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item option value."}},"type":"object","required":["name"],"title":"CreateItemOptionValueRequest","description":"`CreateItemOptionValueRequest` carries a value of a `CreateItemOptionRequest`.","example":{"name":"Small"}},"CreateItemPriceOverrideRequest":{"properties":{"price":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The price of the item at these locations."},"location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"minItems":1,"title":"Location Ids","description":"The unique identifiers of the locations that charge this price."},"id":{"type":"null","title":"Id","description":"Must be `null` or left out: a new record has no `id` yet."}},"type":"object","required":["price","location_ids"],"title":"CreateItemPriceOverrideRequest","description":"`CreateItemPriceOverrideRequest` carries a new price override. It cannot carry an `id`.","example":{"location_ids":["1757511249595-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4200,"currency":"ZAR"}}},"CreateItemRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item."},"description":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Description","description":"A description of the item."},"default_price":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The default price of the item."},"default_barcode":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Default Barcode","description":"The barcode of the item. A variant without a barcode of its own reports this value as its `barcode`."},"default_cost_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"What the merchant pays for one unit of the item."},"default_duration":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32"},{"type":"null"}],"title":"Default Duration","description":"The duration of the service, in minutes."},"type":{"$ref":"#/components/schemas/ItemType","description":"Whether the item is a physical product or a service."},"stock_tracking":{"$ref":"#/components/schemas/StockTracking","description":"Whether the Yoco Point of Sale (POS) app tracks stock for the item: `none` doesn't track stock, `item` keeps one count shared by all of the item's variants, and `variant` keeps a separate count for each variant. Defaults to `none` when you create an item, and can't be `null`.\n\nChanging this can delete stock data. Switching to `none` deletes the item's stock counts and low stock alert levels. Switching from `variant` to `item` deletes each variant's count, alert level and own SKU, so every variant reports the item's SKU. Switching from `item` to `variant` starts each variant without a count and with the item's alert level. Sending the value the item already has leaves its counts, alert levels and SKUs as they are.","default":"none"},"category_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Category Id","description":"The unique identifier of the category the item belongs to."},"brand_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Brand Id","description":"The unique identifier of the brand the item belongs to. Only a `product` can belong to a brand, so a `service` may leave it out."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The unique identifier of the item's image: the `id` of a media item uploaded with `POST /v1/media/`."},"tax_ids":{"anyOf":[{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":10},{"type":"null"}],"title":"Tax Ids","description":"The unique identifiers of the taxes to apply to the item. `null` or `[]` removes the item's own taxes, so the business's default tax applies. To charge no tax, send the id of a tax from `GET /v1/taxes` whose `percentage` is `0`, such as No Tax if the business has one."},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateItemOptionRequest"},"type":"array","maxItems":3},{"type":"null"}],"title":"Options","description":"The options the item varies by, e.g. `Size`. An item with options needs one variant for every combination of their values. Send `[]` or `null` for an item without options."},"variants":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateItemVariantRequest"},"type":"array","maxItems":250},{"type":"null"}],"title":"Variants","description":"The purchasable variants of the item, one for every combination of the item's `options` values. Send `[]` or `null` for an item without variants."},"price_overrides":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateItemPriceOverrideRequest"},"type":"array","maxItems":100},{"type":"null"}],"title":"Price Overrides","description":"The prices the item charges at specific locations, in place of its `default_price`. A location may have only one price override. Send `[]` or `null` to remove every price override from the item."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/CreateItemLocationAvailabilityRequest"},{"type":"null"}],"description":"The locations that sell the item. Send `null` to make the item available at every location."},"modifier_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachItemModifierGroupRequest"},"type":"array","maxItems":50},{"type":"null"}],"title":"Modifier Groups","description":"The modifier groups attached to the item, which apply to every variant. Each group may be attached once, and each `ordinal` used once. Send `[]` or `null` to detach every group."}},"type":"object","required":["name","default_price","type"],"title":"CreateItemRequest","description":"`CreateItemRequest` carries a new item. An optional field left out of the request is stored\nempty.","example":{"brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337","category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","default_barcode":"6001234567890","default_cost_price":{"amount":1200,"currency":"ZAR"},"default_price":{"amount":1500,"currency":"ZAR"},"description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","image_id":"1757511249595-8b2e4c1d-6a7f-4d93-b5e0-2c9f1a3d7e64","location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","ordinal":0}],"name":"Flat White","options":[{"name":"Size","values":[{"name":"Small"},{"name":"Large"}]}],"price_overrides":[{"location_ids":["1757511249595-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4200,"currency":"ZAR"}}],"stock_tracking":"variant","tax_ids":["1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852"],"type":"product","variants":[{"barcode":"12345678","cost_price":{"amount":1200,"currency":"ZAR"},"is_enabled":true,"location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"price":{"amount":1500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Small"}],"sku":"FW-SML"},{"cost_price":{"amount":1500,"currency":"ZAR"},"is_enabled":true,"price":{"amount":4500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Large"}],"sku":"FW-LRG"}]}},"CreateItemVariantRequest":{"properties":{"sku":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Sku","description":"The SKU (stock keeping unit) of the variant. Used only when the item tracks stock per variant. Otherwise every variant uses the item's SKU and this value is ignored. When it is used, `null` or an empty string keeps an existing variant's SKU, and a new variant gets a SKU generated from the item's SKU and its option values."},"barcode":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Barcode","description":"The barcode of the variant."},"price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The price of the variant. Send `null` to charge the item's `default_price`."},"cost_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"What the merchant pays for one unit of the variant. Send `null` to use the item's `default_cost_price`."},"duration":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32"},{"type":"null"}],"title":"Duration","description":"The duration of the service variant, in minutes."},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Whether the variant is available as a purchase option in the Yoco Point of Sale (POS) app.","default":true},"selected_options":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateSelectedOptionRequest"},"type":"array","maxItems":3},{"type":"null"}],"title":"Selected Options","description":"The option value selected for each of the item's `options`, e.g. `Size` of `Small`. Exactly one value is required per option the item declares. Any order is accepted, and the response lists them in the order of the item's `options`. Send `[]` or `null` for an item without options."},"modifier_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachItemModifierGroupRequest"},"type":"array"},{"type":"null"}],"title":"Modifier Groups","description":"Must be `[]` or `null`: modifier groups attach to the item, through its `modifier_groups`, and apply to every variant."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/CreateItemLocationAvailabilityRequest"},{"type":"null"}],"description":"The locations that sell the variant, stored on the variant and not combined with the item's `location_availability`. Send `null` to make the variant available at every location."},"id":{"type":"null","title":"Id","description":"Must be `null` or left out: a new record has no `id` yet."}},"type":"object","title":"CreateItemVariantRequest","description":"`CreateItemVariantRequest` carries a new variant. It cannot carry an `id`, and a field left\nout of the request takes its default.","example":{"barcode":"12345678","cost_price":{"amount":1200,"currency":"ZAR"},"is_enabled":true,"location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"price":{"amount":1500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Small"}],"sku":"FW-SML"}},"CreateModifierGroupRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the modifier group. It must be unique among the business's modifier groups."},"min_selections":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Min Selections","description":"The minimum number of modifiers that must be selected from the group. A value of `0` means the group is optional."},"max_selections":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":1.0},{"type":"null"}],"format":"int32","title":"Max Selections","description":"The maximum number of modifiers that may be selected from the group. A value of `null` means there is no maximum."},"modifiers":{"items":{"$ref":"#/components/schemas/CreateModifierRequest"},"type":"array","maxItems":100,"minItems":1,"title":"Modifiers","description":"The complete set of modifiers in the group. A group holds at least one modifier."}},"type":"object","required":["name","min_selections","modifiers"],"title":"CreateModifierGroupRequest","description":"`CreateModifierGroupRequest` carries a new modifier group. An optional field left out of the\nrequest is stored empty.","example":{"max_selections":1,"min_selections":0,"modifiers":[{"fixed_price":{"amount":1500,"currency":"ZAR"},"is_selected_by_default":false,"name":"Chips","ordinal":1,"pricing_strategy":"fixed_price"}],"name":"Side Orders"}},"CreateModifierRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The display name of the modifier."},"pricing_strategy":{"$ref":"#/components/schemas/PricingStrategy","description":"How the price of the modifier is determined when applied to an item."},"fixed_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The fixed price of the modifier. Required when `pricing_strategy` is `fixed_price`, and `null` when it is `free` or `product`. An amount of `0` is a fixed price of zero."},"is_selected_by_default":{"type":"boolean","title":"Is Selected By Default","description":"Whether the modifier is selected by default when its group is shown to the customer."},"ordinal":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Ordinal","description":"The display ordering of the modifier within its group. Lower values appear first. Unique within the group."},"variant_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Variant Id","description":"The unique identifier of the item variant this modifier adds to the item, or `null` when none is linked. Required when `pricing_strategy` is `product`. On an update, `null` removes the link."},"id":{"type":"null","title":"Id","description":"Must be `null` or left out: a new record has no `id` yet."}},"type":"object","required":["name","pricing_strategy","is_selected_by_default","ordinal"],"title":"CreateModifierRequest","description":"`CreateModifierRequest` carries one modifier of a `CreateModifierGroupRequest`. A new\nmodifier cannot carry an `id`, and an optional field left out of the request is stored empty.","example":{"fixed_price":{"amount":1500,"currency":"ZAR"},"is_selected_by_default":false,"name":"Chips","ordinal":1,"pricing_strategy":"fixed_price"}},"CreateOrderDiscountRequest":{"properties":{"type":{"$ref":"#/components/schemas/DiscountType","description":"How the discount is expressed, which determines whether `amount` or `percentage` applies."},"amount":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The amount to discount by. Required when `type` is `fixed_amount`, and must be omitted otherwise."},"percentage":{"anyOf":[{"type":"number","maximum":100.0,"minimum":0.0},{"type":"string"},{"type":"null"}],"title":"Percentage","description":"The percentage to discount by, to at most two decimal places. For example, `10.00` corresponds to a discount of `10%`. Required when `type` is `fixed_percentage`, and must be omitted otherwise.","example":"10.00"}},"type":"object","required":["type"],"title":"CreateOrderDiscountRequest","description":"A discount applied to an order or to one of its line items.","example":{"percentage":"10.00","type":"fixed_percentage"}},"CreateOrderLineItemRequest":{"properties":{"variant_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Variant Id","description":"The unique identifier of a variant in the merchant's catalogue, as `GET /v1/items` returns it in an item's `variants`. The line takes its name and price from the catalogue, at the order's location when one is set. `name`, `unit_price` and `quantity_unit` must be omitted with it. Items sold by weight, with a price entered at sale, or with a modifier group whose `min_selections` is above 0 cannot be linked.","example":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"},"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"The name of the line item. Required when `variant_id` is omitted, and must be omitted otherwise.","example":"Flat white"},"unit_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The price of a single unit of the line item. Required when `variant_id` is omitted, and must be omitted otherwise."},"quantity":{"anyOf":[{"type":"number","maximum":2147483647.0,"exclusiveMinimum":0.0},{"type":"string"}],"title":"Quantity","description":"The number of units ordered, to at most three decimal places. When `quantity_unit` is omitted, `quantity` is an item count (for example, 4 apples). When `quantity_unit` is set, `quantity` is a measurement (for example, 1.45 kg).","example":"2"},"quantity_unit":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Quantity Unit","description":"The unit that the `quantity` is measured in. Must be omitted when `variant_id` is set.","example":"kg"},"discount":{"anyOf":[{"$ref":"#/components/schemas/CreateOrderDiscountRequest"},{"type":"null"}],"description":"A discount applied to this line item as a whole, not to each unit. A percentage is taken of the line's unit price, the catalogue's for a linked line, multiplied by its `quantity`. The discount may not exceed that amount rounded down to whole cents, and a percentage that rounds up past it is capped there. Returned in the line item's `applied_discounts`."},"taxes":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateOrderLineItemTaxRequest"},"type":"array","maxItems":10},{"type":"null"}],"title":"Taxes","description":"The taxes charged on the line item, each naming a different tax. Required when the order's `pricing_mode` is `supplied`, and must be omitted otherwise. An empty list records the line item as zero-rated."}},"type":"object","required":["quantity"],"title":"CreateOrderLineItemRequest","example":{"name":"Flat white","quantity":"2","unit_price":{"amount":1500,"currency":"ZAR"}}},"CreateOrderLineItemTaxRequest":{"properties":{"tax_id":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$","title":"Tax Id","description":"The unique identifier of one of the merchant's taxes, as `GET /v1/taxes` returns it. The tax's name, rate and type are taken from it.","example":"1739522553-5f2c8a14-3b6d-4e9f-a1c7-8d0e2b4f6a93"},"amount":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The amount of this tax on the whole line item, not on a single unit."}},"type":"object","required":["tax_id","amount"],"title":"CreateOrderLineItemTaxRequest","description":"A tax charged on a line item, recorded as sent.","example":{"amount":{"amount":522,"currency":"ZAR"},"tax_id":"1739522553-5f2c8a14-3b6d-4e9f-a1c7-8d0e2b4f6a93"}},"CreateOrderPaymentRequest":{"properties":{"method":{"$ref":"#/components/schemas/OrderPaymentMethod","description":"How the payment was tendered, which determines whether `tender` applies."},"tender":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Tender","description":"The name of the custom payment method the money was taken through, exactly as you named it on your Yoco account. Required when `method` is `other`, and must be omitted otherwise. Matched without regard to case.","example":"Uber Eats"},"amount":{"$ref":"#/components/schemas/PositiveMoney","description":"The amount collected. Without a tip it may be part of what the order comes to; with a tip above zero, see the rule on the order's `tip`."}},"type":"object","required":["method","amount"],"title":"CreateOrderPaymentRequest","description":"A payment you have already collected, recorded against the order.\n\nSubject to the rule on the order's `tip`: a payment equal to the order total plus any\nservice charges closes the order; a smaller amount leaves it open with the payment\nrecorded against it.\n\nThe payment is recorded only. Yoco does not charge, capture or settle it, and it is not\npaid out to you — the money has already reached you through whichever channel collected\nit, so this exists to keep your Yoco sales history and reporting complete.","example":{"amount":{"amount":4000,"currency":"ZAR"},"method":"other","tender":"Uber Eats"}},"CreateOrderRequest":{"properties":{"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"The currency code in ISO 4217 format. Only `ZAR` is supported. Every nested `Money` amount must use this same currency.","example":"ZAR"},"location_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Location Id","description":"The location at which the sale took place. When omitted, the order is not associated with a location.","example":"93e230af-afc5-4839-a471-ba52f71f9447"},"staff_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Staff Id","description":"The unique identifier of the staff member who created the order. When omitted, the order is attributed to the business owner.","example":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9"},"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"A human-friendly identifier (customer name, table number, order number, etc) representing the order.","example":"Table 42"},"note":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Note","description":"An optional note to attach to the order.","example":"This is a very important table."},"external_id":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"External Id","description":"Your own identifier for the order, stored against it so you can reconcile the order against your records.","example":"UE-8843102"},"channel":{"anyOf":[{"type":"string","maxLength":50,"minLength":1,"pattern":"^[a-z0-9]+(_[a-z0-9]+)*$"},{"type":"null"}],"title":"Channel","description":"Your integration's own channel, as a lowercase slug of at most 50 characters: letters and digits in words joined by single underscores, for example `uber_eats`, other than `null`. Send the same value on every order, because an order's channel cannot be changed after it is created. An `external_id` is unique within a channel, so two channels may each use the same `external_id`.","example":"uber_eats"},"pricing_mode":{"$ref":"#/components/schemas/OrderPricingMode","description":"Who works out the order's total and taxes. With `calculated`, the default, Yoco totals the line items and applies the taxes set up on the merchant's Yoco account. With `supplied`, send `total_amount` and each line item's `taxes`, and Yoco records them as sent.","default":"calculated"},"total_amount":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The order's total: the line items less their own discounts and the order's `discount`, excluding service charges and the tip. It must equal what the line items come to. Required when `pricing_mode` is `supplied`, and must be omitted otherwise."},"line_items":{"items":{"$ref":"#/components/schemas/CreateOrderLineItemRequest"},"type":"array","maxItems":500,"minItems":1,"title":"Line Items","description":"The line items that make up the order."},"discount":{"anyOf":[{"$ref":"#/components/schemas/CreateOrderDiscountRequest"},{"type":"null"}],"description":"A discount applied to the order as a whole, on top of any line item `discount`. A percentage is taken of the line items' total after their own discounts. The discount may not exceed that total rounded down to whole cents, and a percentage that rounds up past it is capped there. Returned as `amounts.discount_amount`."},"tip":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"A tip left on the order, over and above the price of the goods. Returned as `amounts.tip_amount`. When `payment` is set and the tip is above zero, the payment must equal the order total plus any service charges and the tip. A tip sent without a payment holds only until a payment is recorded against the order, which then takes as the tip whatever was paid above the order total plus service charges."},"service_charges":{"anyOf":[{"items":{"$ref":"#/components/schemas/CreateOrderServiceChargeRequest"},"type":"array","maxItems":20},{"type":"null"}],"title":"Service Charges","description":"Charges levied by the ordering channel, such as delivery or a service fee. These are retained by the channel rather than handed to the business. Distinct from `Payment.processing_fees`, which is what Yoco charges the merchant."},"payment":{"anyOf":[{"$ref":"#/components/schemas/CreateOrderPaymentRequest"},{"type":"null"}],"description":"A payment you have already collected for this order. Subject to the rule on `tip`: a payment equal to the order total plus any service charges closes the order; a smaller amount leaves it open with the payment recorded against it. When omitted, the order is created open. Yoco does not charge, capture or settle the payment."}},"type":"object","required":["currency","line_items"],"title":"CreateOrderRequest","example":{"channel":"uber_eats","currency":"ZAR","discount":{"percentage":"10.00","type":"fixed_percentage"},"external_id":"UE-8843102","line_items":[{"name":"Flat white","quantity":"2","unit_price":{"amount":1500,"currency":"ZAR"}},{"name":"Biltong","quantity":"1.450","quantity_unit":"kg","unit_price":{"amount":1299,"currency":"ZAR"}},{"discount":{"amount":{"amount":500,"currency":"ZAR"},"type":"fixed_amount"},"name":"Croissant","quantity":"2","unit_price":{"amount":3500,"currency":"ZAR"}}],"location_id":"93e230af-afc5-4839-a471-ba52f71f9447","name":"Table 42","note":"This is a very important table.","payment":{"amount":{"amount":13246,"currency":"ZAR"},"method":"other","tender":"Uber Eats"},"service_charges":[{"amount":{"amount":2500,"currency":"ZAR"},"name":"Delivery"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","tip":{"amount":500,"currency":"ZAR"}}},"CreateOrderServiceChargeRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"A human-friendly name for the charge.","example":"Delivery"},"amount":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The amount charged by the channel. May be zero, for example a free delivery shown as a R0 line."}},"type":"object","required":["name","amount"],"title":"CreateOrderServiceChargeRequest","example":{"amount":{"amount":2500,"currency":"ZAR"},"name":"Delivery"}},"CreatePaymentLinkRequest":{"properties":{"customer_reference":{"type":"string","maxLength":100,"minLength":1,"title":"Customer Reference","description":"The customer's name or reference that will appear on the payment page."},"customer_description":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Customer Description","description":"An optional description that will appear on the payment page."},"amount":{"$ref":"#/components/schemas/Money","description":"The amount to charge the customer."}},"type":"object","required":["customer_reference","amount"],"title":"CreatePaymentLinkRequest","example":{"amount":{"amount":1500,"currency":"ZAR"},"customer_description":"This description is visible to the customer on the payment page.","customer_reference":"Peter Parker"}},"CreateSelectedOptionRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item option."},"value":{"type":"string","maxLength":255,"minLength":1,"title":"Value","description":"The value of the option for this variant."}},"type":"object","required":["name","value"],"title":"CreateSelectedOptionRequest","description":"`CreateSelectedOptionRequest` carries a selected option of a `CreateItemVariantRequest`.","example":{"name":"Size","value":"Small"}},"CreateWebPOSDeviceRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"A friendly device name."}},"type":"object","required":["name"],"title":"CreateWebPOSDeviceRequest","example":{"name":"My Web POS"}},"CreateWebPOSPaymentRequest":{"properties":{"amount":{"$ref":"#/components/schemas/Money","description":"The amount of money to charge the buyer."},"client_reference":{"type":"string","maxLength":255,"minLength":1,"title":"Client Reference","description":"Any reference value as determined by the host POS. It is associated with the payment and will be echoed back."},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"Any map of metadata as determined by the host POS. It is associated with the payment and will be echoed back."}},"type":"object","required":["amount","client_reference"],"title":"CreateWebPOSPaymentRequest","example":{"amount":{"amount":200,"currency":"ZAR"},"client_reference":"af4a8c17-5720-4a8b-aab1-4619667eaa02","metadata":{"dev":"true"}}},"CreateWebhookSubscriptionRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"A friendly name to describe the subscription."},"event_types":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","minItems":1,"title":"Event Types","description":"A list of event types to bind the subscription to."},"notification_url":{"type":"string","maxLength":2083,"minLength":1,"format":"uri","title":"Notification Url","description":"The URL to be notified when an event occurs. It must use HTTPS and point to a public host."}},"type":"object","required":["name","event_types","notification_url"],"title":"CreateWebhookSubscriptionRequest","example":{"event_types":["payment.created"],"name":"Example Webhook Subscription","notification_url":"https://webhook.site/1d9d0c3c-c0f9-4def-8cf1-99efb5931eca"}},"DiscountItem":{"properties":{"name":{"type":"string","title":"Name","description":"A human-readable name for the discount."},"type":{"$ref":"#/components/schemas/DiscountType","description":"The type of discount affects how the discount is calculated."},"percentage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Percentage","description":"If applicable, the percentage discount to apply. For example, `10.00` corresponds to a discount of `10%`. A line item's percentage is derived from its discount and price, to one decimal place."},"discount_amount":{"$ref":"#/components/schemas/Money","description":"The calculated discount."},"scope":{"$ref":"#/components/schemas/DiscountScope","description":"The scope indicates the level at which the discount is applied."}},"type":"object","required":["name","type","percentage","discount_amount","scope"],"title":"DiscountItem","example":{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}},"DiscountScope":{"type":"string","enum":["line_item","order"],"title":"DiscountScope","description":"`DiscountScope` can be either `order` or `line_item` and indicates whether the given discount is applied to\nthe entire order, or just a particular line item in the order."},"DiscountType":{"type":"string","enum":["fixed_amount","fixed_percentage"],"title":"DiscountType","description":"`DiscountType` can be either `fixed_percentage` or `fixed_amount` and affects how the discount is calculated.\n\nFor `fixed_percentage`, we apply a percentage on the amount to calculate the discount.\n\nFor `fixed_amount`, the discount is always a positive absolute amount."},"EmvApplicationInfo":{"properties":{"application_identifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Identifier","description":"Application Identifier 'AppID' used for the card transaction"},"application_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Application Name","description":"The name associated with the application identifier"}},"type":"object","title":"EmvApplicationInfo","example":{"application_identifier":"A0000000031010","application_name":"VISA DEBIT"}},"ErrorCode":{"type":"string","enum":["conflict","content_too_large","forbidden","method_not_allowed","missing_required_field","not_found","rate_limited","server","service_unavailable","unauthorized","unsupported_media_type","validation"],"title":"ErrorCode","description":"`ErrorCode` is a unique code representing the type of error that occurred."},"ErrorDetail":{"properties":{"detail":{"type":"string","title":"Detail","description":"A human-readable explanation of what went wrong."},"pointer":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pointer","description":"A JSON pointer to the request body property that caused the error."},"parameter":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Parameter","description":"The name of the query string parameter, path parameter or header that caused the error."},"code":{"$ref":"#/components/schemas/ErrorCode","description":"A unique code representing the type of error that occurred."}},"type":"object","required":["detail","code"],"title":"ErrorDetail","description":"`ErrorDetail` contains additional error information to accompany an `ErrorResponse`.  It is an extension on the\n\"problem detail\" JSON response modelled in https://www.rfc-editor.org/rfc/rfc9457.html.\n\nAs an example, in the event of a 400 \"Validation Error\" type response, the response may contain one or many\n`ErrorDetail` records with more specific information on each field that failed validation.","example":{"code":"missing_required_field","detail":"The field is required.","pointer":"#/first_name"}},"ErrorResponse":{"properties":{"type":{"type":"string","title":"Type","description":"A URI reference that identifies the type of problem."},"title":{"type":"string","title":"Title","description":"A short human-readable summary of the problem."},"detail":{"type":"string","title":"Detail","description":"A human-readable explanation of what went wrong."},"status":{"type":"integer","title":"Status","description":"A HTTP status code generated by the server."},"code":{"$ref":"#/components/schemas/ErrorCode","description":"A unique code representing the type of error that occurred."},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/ErrorDetail"},"type":"array"},{"type":"null"}],"title":"Errors","description":"A list of further error details to accompany a problem details response."}},"type":"object","required":["type","title","detail","status","code"],"title":"ErrorResponse","description":"`ErrorResponse` is a RFC 7807 aka \"problem details\" compatible response.\n\nSee the following references:\n- https://www.rfc-editor.org/rfc/rfc9457.html\n- https://problems-registry.smartbear.com/","example":{"code":"validation","detail":"The request contains one or more validation errors.","errors":[{"code":"missing_required_field","detail":"The field is required.","pointer":"#/first_name"}],"status":400,"title":"Validation Error","type":"https://developer.yoco.com/docs/api/error-codes/validation"}},"ExpandableItem":{"type":"string","enum":["brand","category","location_availability","price_overrides"],"title":"ExpandableItem","description":"`ExpandableItem` represents the related entities that can be expanded on an item response.\n\nBy default, the API returns only the identifiers of related entities (e.g. `category_id`, `brand_id`).\nPass `expand` query parameters to inflate the corresponding nested entity in the response."},"Fee":{"properties":{"type":{"$ref":"#/components/schemas/FeeType","description":"The type of fee assessed or adjusted."},"amount":{"$ref":"#/components/schemas/Money","description":"The fee amount."}},"type":"object","required":["type","amount"],"title":"Fee","example":{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}},"FeeType":{"type":"string","enum":["initial"],"title":"FeeType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ItemBrand":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the brand."},"name":{"type":"string","title":"Name","description":"The name of the brand."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the brand."},"image":{"anyOf":[{"$ref":"#/components/schemas/Media"},{"type":"null"}],"description":"The image to show in the Yoco Point of Sale (POS) app."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The brand creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the brand was last modified in ISO 8601 format."}},"type":"object","required":["id","name","description","image","created_at","updated_at"],"title":"ItemBrand","example":{"created_at":"2024-11-19T15:27:02+00:00","description":"Everyday products, built to last.","id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337","image":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"},"name":"Acme","updated_at":"2024-11-19T16:27:23+00:00"}},"ItemCategory":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the category."},"name":{"type":"string","title":"Name","description":"The name of the category."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the category."},"image":{"anyOf":[{"$ref":"#/components/schemas/Media"},{"type":"null"}],"description":"The image to show in the Yoco Point of Sale (POS) app."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The category creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the category was last modified in ISO 8601 format."},"parent_category":{"anyOf":[{"$ref":"#/components/schemas/ParentItemCategory"},{"type":"null"}],"description":"The parent category, if any, of this category."}},"type":"object","required":["id","name","description","image","created_at","updated_at","parent_category"],"title":"ItemCategory","example":{"created_at":"2024-11-19T15:27:02+00:00","description":"A home for all our tasty warm beverages.","id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","image":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"},"name":"Hot Beverages","parent_category":{"created_at":"2024-11-19T15:27:02+00:00","description":"A home for all our beverages.","id":"1757511225824-ab79f3ee-5a21-4bca-a060-ef27d9aae788","image":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"},"name":"Beverages","updated_at":"2024-11-19T16:27:23+00:00"},"updated_at":"2024-11-19T16:27:23+00:00"}},"ItemCategoryCreated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_category_id":{"type":"string","title":"Item Category Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_category_id","event_type"],"title":"ItemCategoryCreated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item_category.created","item_category_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}},"ItemCategoryDeleted":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_category_id":{"type":"string","title":"Item Category Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_category_id","event_type"],"title":"ItemCategoryDeleted","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item_category.deleted","item_category_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}},"ItemCategoryUpdated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_category_id":{"type":"string","title":"Item Category Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_category_id","event_type"],"title":"ItemCategoryUpdated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item_category.updated","item_category_id":"b2c3d4e5-f6a7-8901-bcde-f12345678901"}},"ItemCreated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_id":{"type":"string","title":"Item Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_id","event_type"],"title":"ItemCreated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item.created","item_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"ItemDeleted":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_id":{"type":"string","title":"Item Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_id","event_type"],"title":"ItemDeleted","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item.deleted","item_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"ItemLocationAvailability":{"properties":{"is_available_at_all_locations":{"type":"boolean","title":"Is Available At All Locations","description":"Whether the item is available at all locations by default."},"included_location_ids":{"items":{"type":"string"},"type":"array","title":"Included Location Ids","description":"Location IDs where the item is explicitly available. Populated when `is_available_at_all_locations` is `false`; empty otherwise."},"excluded_location_ids":{"items":{"type":"string"},"type":"array","title":"Excluded Location Ids","description":"Location IDs where the item is explicitly unavailable. Populated when `is_available_at_all_locations` is `true`; empty otherwise."}},"type":"object","required":["is_available_at_all_locations"],"title":"ItemLocationAvailability","example":{"excluded_location_ids":["1700000000000-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"included_location_ids":[],"is_available_at_all_locations":true}},"ItemModifierGroup":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the modifier group."},"name":{"type":"string","title":"Name","description":"The name of the modifier group."},"min_selections":{"type":"integer","title":"Min Selections","description":"The minimum number of modifiers that must be selected from the group. A value of `0` means the group is optional."},"max_selections":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Selections","description":"The maximum number of modifiers that may be selected from the group. A value of `null` means there is no maximum."},"ordinal":{"type":"integer","title":"Ordinal","description":"The display ordering of the group on its parent item or variant. Lower values appear first."},"modifiers":{"items":{"$ref":"#/components/schemas/Modifier"},"type":"array","title":"Modifiers","description":"The modifiers that belong to this group."}},"type":"object","required":["id","name","min_selections","max_selections","ordinal"],"title":"ItemModifierGroup","description":"A `ModifierGroup` as it appears attached to a specific item or variant.\n\nSame `id`, `name`, and selection rules as the underlying `ModifierGroup`, plus an\n`ordinal` that controls the display ordering of the group relative to other modifier\ngroups on the same item or variant; lower values appear before higher values. A group\ncan be attached at the item level (applies to all variants) or at the variant level\n(specific to that variant only).","example":{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","max_selections":2,"min_selections":0,"modifiers":[{"fixed_price":{"amount":500,"currency":"ZAR"},"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","is_selected_by_default":false,"modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Chips","ordinal":1,"pricing_strategy":"fixed_price","type":"product","variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Side Orders","ordinal":1}},"ItemOption":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the item option."},"name":{"type":"string","title":"Name","description":"The name of the item option."},"values":{"items":{"$ref":"#/components/schemas/ItemOptionValue"},"type":"array","title":"Values","description":"A list of values that form the item option."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The item option creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the item option was last modified in ISO 8601 format."}},"type":"object","required":["id","name","created_at","updated_at"],"title":"ItemOption","example":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757523968431-318ba3de-0f7c-47ca-b3c2-36a1cd5cac73","name":"Size","updated_at":"2024-11-19T16:27:23+00:00","values":[{"name":"Small"},{"name":"Medium"},{"name":"Large"}]}},"ItemOptionValue":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the item option value."}},"type":"object","required":["name"],"title":"ItemOptionValue","example":{"name":"Small"}},"ItemPriceOverride":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the price override."},"price":{"$ref":"#/components/schemas/Money","description":"The override price."},"location_ids":{"items":{"type":"string"},"type":"array","title":"Location Ids","description":"The location IDs this price override applies to."}},"type":"object","required":["id","price","location_ids"],"title":"ItemPriceOverride","example":{"id":"1700000000000-2c8e1f4a-5d6b-4e7f-8a9b-0c1d2e3f4a5b","location_ids":["1700000000000-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4500,"currency":"ZAR"}}},"ItemTax":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the tax."},"name":{"type":"string","title":"Name","description":"A human-readable name for the tax."},"type":{"$ref":"#/components/schemas/TaxType","description":"The type of tax affects the method used to calculate the tax."},"percentage":{"type":"string","title":"Percentage","description":"The tax rate to apply. For example, `15.00` corresponds to a tax rate of `15%`."}},"type":"object","required":["id","name","type","percentage"],"title":"ItemTax","example":{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","percentage":"15.00","type":"inclusive"}},"ItemType":{"type":"string","enum":["product","service"],"title":"ItemType"},"ItemUpdated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"item_id":{"type":"string","title":"Item Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","item_id","event_type"],"title":"ItemUpdated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"item.updated","item_id":"a1b2c3d4-e5f6-7890-abcd-ef1234567890"}},"ItemVariant":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the variant."},"sku":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Sku","description":"The SKU (stock keeping unit) of the variant. When the item does not track stock per variant, every variant shows the item's SKU."},"barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Barcode","description":"The barcode of the variant. If the variant has no barcode, this field shows the `default_barcode` of the item. All variants that have no barcode show the same value."},"price":{"$ref":"#/components/schemas/Money","description":"The price of the variant."},"cost_price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"What the merchant pays for one unit of the variant. `null` when the variant uses the item's `default_cost_price`."},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"The duration of the service variant, in minutes."},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Whether the variant is available as a purchase option in the Yoco Point of Sale (POS) app."},"selected_options":{"items":{"$ref":"#/components/schemas/SelectedOption"},"type":"array","title":"Selected Options","description":"The option values selected for this variant, ordered to match the item's `options`. Each entry pairs an option group name (e.g. `Size`) with the value chosen for this variant (e.g. `Small`)."},"modifier_groups":{"items":{"$ref":"#/components/schemas/ItemModifierGroup"},"type":"array","title":"Modifier Groups","description":"The modifier groups attached specifically to this variant."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The variant creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the variant was last modified in ISO 8601 format."},"price_overrides":{"anyOf":[{"items":{"$ref":"#/components/schemas/ItemPriceOverride"},"type":"array"},{"type":"null"}],"title":"Price Overrides","description":"The location-specific price overrides for this variant. Present when `price_overrides` is requested via the `expand` query parameter, and always on create and update responses."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/ItemLocationAvailability"},{"type":"null"}],"description":"The location availability configuration for this variant, as stored on the variant. It is not combined with the item's `location_availability`. Present when `location_availability` is requested via the `expand` query parameter, and always on create and update responses."}},"type":"object","required":["id","sku","barcode","price","cost_price","duration","is_enabled","created_at","updated_at"],"title":"ItemVariant","example":{"barcode":"12345678","cost_price":{"amount":1200,"currency":"ZAR"},"created_at":"2024-11-19T15:27:02+00:00","id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6","is_enabled":true,"location_availability":{"excluded_location_ids":["1700000000000-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"included_location_ids":[],"is_available_at_all_locations":true},"modifier_groups":[],"price":{"amount":3800,"currency":"ZAR"},"price_overrides":[{"id":"1700000000000-2c8e1f4a-5d6b-4e7f-8a9b-0c1d2e3f4a5b","location_ids":["1700000000000-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4500,"currency":"ZAR"}}],"selected_options":[{"name":"Size","value":"Small"}],"sku":"FW-001","updated_at":"2024-11-19T16:27:23+00:00"}},"ListResponse_CapitalAdvance_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CapitalAdvance"},"type":"array","title":"Data","description":"A list of entities."}},"type":"object","required":["data"],"title":"ListResponse[CapitalAdvance]","example":{"data":[]}},"ListResponse_CapitalOffer_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CapitalOffer"},"type":"array","title":"Data","description":"A list of entities."}},"type":"object","required":["data"],"title":"ListResponse[CapitalOffer]","example":{"data":[]}},"ListResponse_WebhookEventDefinition_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookEventDefinition"},"type":"array","title":"Data","description":"A list of entities."}},"type":"object","required":["data"],"title":"ListResponse[WebhookEventDefinition]","example":{"data":[]}},"Location":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the location."},"name":{"type":"string","title":"Name","description":"The name of the location."},"status":{"$ref":"#/components/schemas/LocationStatus","description":"The status of the location. `active` locations are trading. `deactivating` locations have a scheduled deactivation and keep trading until it takes effect. `inactive` locations are deactivated and no longer trading."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The location creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the location was last modified in ISO 8601 format."}},"type":"object","required":["id","name","status","created_at","updated_at"],"title":"Location","example":{"created_at":"2024-11-19T15:27:02+00:00","id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","name":"Main Store","status":"active","updated_at":"2024-11-19T16:27:23+00:00"}},"LocationStatus":{"type":"string","enum":["active","deactivating","inactive"],"title":"LocationStatus"},"Media":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the media."},"type":{"$ref":"#/components/schemas/MediaType","description":"The type of media."},"mime_type":{"type":"string","title":"Mime Type","description":"The mime type indicates the format of the media."},"url":{"type":"string","title":"Url","description":"The URL of the media file."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The media creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the media was last modified in ISO 8601 format."}},"type":"object","required":["id","type","mime_type","url","created_at","updated_at"],"title":"Media","example":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"}},"MediaCategory":{"type":"string","enum":["catalogue"],"title":"MediaCategory"},"MediaType":{"type":"string","enum":["image"],"title":"MediaType"},"Modifier":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the modifier."},"modifier_group_id":{"type":"string","title":"Modifier Group Id","description":"The unique identifier of the modifier group this modifier belongs to."},"type":{"$ref":"#/components/schemas/ModifierType","description":"The type of the modifier, set by `variant_id`: `product` when the modifier is linked to an item variant, `note` when it is not (e.g. `Well-Done`). Both `note` and `product` modifiers may carry a charge, set by `pricing_strategy`."},"name":{"type":"string","title":"Name","description":"The display name of the modifier."},"pricing_strategy":{"$ref":"#/components/schemas/PricingStrategy","description":"How the price of the modifier is determined when applied to an item."},"fixed_price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"The fixed price of the modifier. Populated only when `pricing_strategy` is `fixed_price`."},"is_selected_by_default":{"type":"boolean","title":"Is Selected By Default","description":"Whether the modifier is selected by default when its group is shown to the customer."},"ordinal":{"type":"integer","title":"Ordinal","description":"The display ordering of the modifier within its group. Lower values appear first."},"variant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Id","description":"The unique identifier of the item variant linked to this modifier, or `null` when none is linked. A linked modifier has the `type` `product`."}},"type":"object","required":["id","modifier_group_id","type","name","pricing_strategy","fixed_price","is_selected_by_default","ordinal","variant_id"],"title":"Modifier","description":"A customisation that a customer can apply to an item at sale time.\n\nA modifier always belongs to a single `ModifierGroup` (e.g. \"Side Orders\" or \"Doneness\").\nA `note` modifier has no linked item variant, such as \"Well-Done\".\nA `product` modifier is linked to an item variant via `variant_id`.\nBoth `note` and `product` modifiers may carry a charge, set by `pricing_strategy`.","example":{"fixed_price":{"amount":500,"currency":"ZAR"},"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","is_selected_by_default":false,"modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Chips","ordinal":1,"pricing_strategy":"fixed_price","type":"product","variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}},"ModifierGroup":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the modifier group."},"name":{"type":"string","title":"Name","description":"The name of the modifier group."},"min_selections":{"type":"integer","title":"Min Selections","description":"The minimum number of modifiers that must be selected from the group. A value of `0` means the group is optional."},"max_selections":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Max Selections","description":"The maximum number of modifiers that may be selected from the group. A value of `null` means there is no maximum."},"modifiers":{"items":{"$ref":"#/components/schemas/Modifier"},"type":"array","title":"Modifiers","description":"The modifiers that belong to this group."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The modifier group creation date and time in ISO 8601 format."}},"type":"object","required":["id","name","min_selections","max_selections","created_at"],"title":"ModifierGroup","description":"A reusable collection of modifiers that share selection rules.\n\nEach group owns one or more `Modifier` options and defines `min_selections` and\n`max_selections` to constrain how many can be chosen at sale time. Groups exist\nindependently of items and are reused across the catalogue — a single \"Doneness\" group\ncan be attached to many products. When a group is attached to a product or variant for\nsale, the item-side view is `ItemModifierGroup`.","example":{"created_at":"2024-11-19T15:27:02+00:00","id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","max_selections":2,"min_selections":0,"modifiers":[{"fixed_price":{"amount":500,"currency":"ZAR"},"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","is_selected_by_default":false,"modifier_group_id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","name":"Chips","ordinal":1,"pricing_strategy":"fixed_price","type":"product","variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Side Orders"}},"ModifierType":{"type":"string","enum":["note","product"],"title":"ModifierType","description":"`ModifierType` distinguishes between a `note` modifier and a `product` modifier.\n\nA `note` modifier has no linked item variant, such as \"medium-rare\".\nA `product` modifier adds an item variant to the item, linked through `variant_id`.\nBoth `note` and `product` modifiers may carry a charge, set by `pricing_strategy`."},"Money":{"properties":{"amount":{"type":"integer","format":"int32","title":"Amount","description":"The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents."},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"The currency code in ISO 4217 format."}},"type":"object","required":["amount","currency"],"title":"Money","description":"`Money` represents a monetary value denoted by both an amount and a currency.\n\nThe `amount` is always going to be the smallest denomination of the given currency. As an example, when dealing\nwith South African Rands (ZAR), the amount is in cents.\neg: R150.45 is therefore represented by `Money(amount=15045, currency=\"ZAR\")`.","example":{"amount":1500,"currency":"ZAR"}},"NonNegativeMoney":{"properties":{"amount":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Amount","description":"The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents."},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"The currency code in ISO 4217 format."}},"type":"object","required":["amount","currency"],"title":"NonNegativeMoney","description":"`NonNegativeMoney` is a `Money` whose amount is not negative.","example":{"amount":1500,"currency":"ZAR"}},"Order":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the order."},"display_name":{"type":"string","title":"Display Name","description":"A human-friendly label for the order."},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number","description":"A human-friendly identifier for the order."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"A human-friendly identifier (customer name, table number, order number, etc) representing the order."},"currency":{"type":"string","title":"Currency","description":"The currency code in ISO 4217 format."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"An optional note attached to the order."},"location_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location Id","description":"The location at which the sale took place."},"staff_id":{"type":"string","title":"Staff Id","description":"The unique identifier of the staff member who created the order. Matches the `id` returned by the Staff API."},"channel":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Channel","description":"The channel the order originated from: the originating integration's own lowercase slug, for example `uber_eats`. Set when the order is created, and never changed after."},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"The originating integration's own identifier for the order, used to reconcile the order against the channel's records."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The order creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the order was last modified in ISO 8601 format."},"closed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Closed At","description":"The date and time the order was closed in ISO 8601 format."},"status":{"$ref":"#/components/schemas/OrderStatus","description":"The current state of the order."},"amounts":{"$ref":"#/components/schemas/OrderAmounts","description":"A collection of summarized amounts on the order."},"line_items":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array","title":"Line Items","description":"A list of line items making up the order."},"total_taxes":{"items":{"$ref":"#/components/schemas/OrderTaxItem"},"type":"array","title":"Total Taxes","description":"A list of taxes across all line items, one entry per sales tax. Two sales taxes can share a name."},"applied_discounts":{"items":{"$ref":"#/components/schemas/DiscountItem"},"type":"array","title":"Applied Discounts","description":"The discounts applicable to the order."},"service_charges":{"items":{"$ref":"#/components/schemas/ServiceChargeItem"},"type":"array","title":"Service Charges","description":"The service charges levied against the order by the sales channel."},"payments":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array","title":"Payments","description":"The payments that have been receipted against the order."},"refunds":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array","title":"Refunds","description":"The refunds that have been issued against the order."},"returns":{"items":{"$ref":"#/components/schemas/Return"},"type":"array","title":"Returns","description":"A list of returns associated with this order."}},"type":"object","required":["id","display_name","order_number","name","currency","note","location_id","staff_id","created_at","updated_at","closed_at","status","amounts"],"title":"Order","example":{"amounts":{"discount_amount":{"amount":2780,"currency":"ZAR"},"gross_amount":{"amount":16680,"currency":"ZAR"},"net_amount":{"amount":16400,"currency":"ZAR"},"service_charge_amount":{"amount":2500,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"}},"applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"channel":"uber_eats","closed_at":"2024-11-19T16:27:23+00:00","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Order #10542623","external_id":"UE-8843102","id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","line_items":[{"applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"applied_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"discount_amount":{"amount":2780,"currency":"ZAR"},"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","item_type":"product","modifiers":[{"group_name":"Side Orders","group_ordinal":1,"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","name":"Chips","ordinal":1,"price":{"amount":500,"currency":"ZAR"},"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Men's Funky Blue T-Shirt - Medium","net_amount":{"amount":25020,"currency":"ZAR"},"note":"This is an optional note related to this item in the order.","quantity":"1.000","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","total_price":{"amount":13900,"currency":"ZAR"},"unit_price":{"amount":13900,"currency":"ZAR"},"variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"}],"location_id":"93e230af-afc5-4839-a471-ba52f71f9447","name":"Table 42","note":"This is a very important table.","order_number":"10542623","payments":[{"amount_excl_tip":{"amount":25000,"currency":"ZAR"},"card_machine_id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","checkout_id":"ch_J2xYWl4m7B6DsKAPCM9SRDEd","client_transaction_id":"5f29b4cf-5650-4c71-b7e5-f70eb892e55f","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Payment receipt #491352","external_id":"order-123","id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","note":"This is a note on this payment.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","payment_method":"card","payment_source":"payment_link","receipt_number":"491352","refunded_amount":{"amount":0,"currency":"ZAR"},"refunds":[{"client_transaction_id":"rfd_765fde5ded7bxd","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Refund receipt #491352","id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","note":"This is a note on this refund.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","payment_method":"card","processed_at":"2024-11-20T16:27:23+00:00","processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"receipt_number":"491352","refund_type":"auth_reversal","refunded_processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","total_amount":{"amount":4500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}],"service_charge_amount":{"amount":1250,"currency":"ZAR"},"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","tip_amount":{"amount":2500,"currency":"ZAR"},"total_amount":{"amount":27500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}],"refunds":[{"client_transaction_id":"rfd_765fde5ded7bxd","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Refund receipt #491352","id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","note":"This is a note on this refund.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","payment_method":"card","processed_at":"2024-11-20T16:27:23+00:00","processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"receipt_number":"491352","refund_type":"auth_reversal","refunded_processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","total_amount":{"amount":4500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}],"returns":[{"amounts":{"discount_amount":{"amount":2780,"currency":"ZAR"},"gross_amount":{"amount":16680,"currency":"ZAR"},"net_amount":{"amount":13900,"currency":"ZAR"},"service_charge_amount":{"amount":0,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"}},"returned_applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"returned_line_items":[{"applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"applied_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"discount_amount":{"amount":2780,"currency":"ZAR"},"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","item_type":"product","modifiers":[{"group_name":"Side Orders","group_ordinal":1,"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","name":"Chips","ordinal":1,"price":{"amount":500,"currency":"ZAR"},"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Men's Funky Blue T-Shirt - Medium","net_amount":{"amount":25020,"currency":"ZAR"},"note":"This is an optional note related to this item in the order.","quantity":"1.000","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","total_price":{"amount":13900,"currency":"ZAR"},"unit_price":{"amount":13900,"currency":"ZAR"},"variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"}],"returned_total_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"source_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d"}],"service_charges":[{"amount":{"amount":2500,"currency":"ZAR"},"id":"1585232943682-b3f0a1c2-9d4e-4f6a-8b1c-2d3e4f5a6b7c","name":"Delivery fee"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"completed","total_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"updated_at":"2024-11-19T16:27:23+00:00"}},"OrderAmounts":{"properties":{"gross_amount":{"$ref":"#/components/schemas/Money","description":"The total before any discount is applied. Excludes service charges, which are retained by the sales channel."},"discount_amount":{"$ref":"#/components/schemas/Money","description":"The total amount of discounts."},"tip_amount":{"$ref":"#/components/schemas/Money","description":"The total tip amount."},"net_amount":{"$ref":"#/components/schemas/Money","description":"The total amount of money to change hands."},"tax_amount":{"$ref":"#/components/schemas/Money","description":"The total tax amount."},"service_charge_amount":{"$ref":"#/components/schemas/Money","description":"The total of any service charges (delivery, packaging, small-order) levied by the sales channel. Included in `net_amount` but not in `gross_amount`. Service charges are retained by the channel rather than earned by the business, so subtract this from `net_amount` to get what the business received for the order, including any tip."}},"type":"object","required":["gross_amount","discount_amount","tip_amount","net_amount","tax_amount","service_charge_amount"],"title":"OrderAmounts","example":{"discount_amount":{"amount":2780,"currency":"ZAR"},"gross_amount":{"amount":16680,"currency":"ZAR"},"net_amount":{"amount":16400,"currency":"ZAR"},"service_charge_amount":{"amount":2500,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"}}},"OrderCancelled":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","event_type"],"title":"OrderCancelled","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"order.cancelled","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3"}},"OrderCompleted":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","event_type"],"title":"OrderCompleted","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"order.completed","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3"}},"OrderCreated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","event_type"],"title":"OrderCreated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"order.created","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3"}},"OrderLineItem":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the item in the order."},"variant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Id","description":"An optional reference to the variant of a product. If unrelated to a product, such as when charging a custom amount on a payment terminal, this will be empty."},"name":{"type":"string","title":"Name","description":"A human-readable name for the line item, such as the name of a specific variation of a product."},"quantity":{"type":"string","title":"Quantity","description":"The number of units ordered. If `quantity` is a whole number and `quantity_unit` is not specified, then `quantity` denotes an item count (eg: 4 x apples). If `quantity` isa  whole number or a decimal number, and `quantity_unit` is specified, then `quantity` denotes a measurement (eg: 1.45 kg). `quantity` has at least three decimal places, and a quantity recorded with more places keeps all of them."},"quantity_unit":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Quantity Unit","description":"The unit that the `quantity` is measured in."},"duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Duration","description":"The duration of the line item, in minutes, as recorded at the time of sale. `null` when none was recorded, such as on a custom amount or an item with no duration set."},"item_type":{"$ref":"#/components/schemas/OrderLineItemItemType","description":"The type of line item."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"An optional note attached to the item."},"unit_price":{"$ref":"#/components/schemas/Money","description":"The unit price is the price of 1 unit of the item."},"total_price":{"$ref":"#/components/schemas/Money","description":"The total price is the unit price multiplied by the quantity, rounded half up to the smallest denomination of the currency."},"discount_amount":{"$ref":"#/components/schemas/Money","description":"The total amount of discounts on the item."},"net_amount":{"$ref":"#/components/schemas/Money","description":"The total amount of money to change hands."},"applied_taxes":{"items":{"$ref":"#/components/schemas/OrderTaxItem"},"type":"array","title":"Applied Taxes","description":"The taxes applicable to the item."},"applied_discounts":{"items":{"$ref":"#/components/schemas/DiscountItem"},"type":"array","title":"Applied Discounts","description":"The discounts applicable to the item."},"modifiers":{"items":{"$ref":"#/components/schemas/OrderLineItemModifier"},"type":"array","title":"Modifiers","description":"The modifiers selected on the item at the time of sale."},"staff_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staff Id","description":"The unique identifier of the staff member credited with the line item. Matches the `id` returned by the Staff API. Each line item in an order can credit a different staff member, and this can differ from the order's `staff_id`, which is the staff member who created the order. `null` when no staff member is assigned to the line item."}},"type":"object","required":["id","variant_id","name","quantity","quantity_unit","duration","item_type","note","unit_price","total_price","discount_amount","net_amount","applied_taxes","applied_discounts","staff_id"],"title":"OrderLineItem","example":{"applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"applied_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"discount_amount":{"amount":2780,"currency":"ZAR"},"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","item_type":"product","modifiers":[{"group_name":"Side Orders","group_ordinal":1,"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","name":"Chips","ordinal":1,"price":{"amount":500,"currency":"ZAR"},"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Men's Funky Blue T-Shirt - Medium","net_amount":{"amount":25020,"currency":"ZAR"},"note":"This is an optional note related to this item in the order.","quantity":"1.000","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","total_price":{"amount":13900,"currency":"ZAR"},"unit_price":{"amount":13900,"currency":"ZAR"},"variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"}},"OrderLineItemItemType":{"type":"string","enum":["custom_amount","gift_voucher","product","service"],"title":"OrderLineItemItemType","description":"`OrderLineItemItemType` represents the type of line item within an order.\n\nA known item added via the POS, such as a cup of coffee, will have a type of `product`.  An item sold from a\nservice, such as a haircut, will have a type of `service`; services sold before Yoco began recording the type\nhave a type of `product`.  If an amount is an arbitrary amount, it will have type `custom_amount`.  The purchase\nof a gift voucher, redeemable at a later time, will have a type of `gift_voucher`."},"OrderLineItemModifier":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the line item modifier."},"modifier_id":{"type":"string","title":"Modifier Id","description":"The unique identifier of the source modifier. May reference a modifier that has since been deleted."},"group_name":{"type":"string","title":"Group Name","description":"The display name of the modifier group at sale time."},"group_ordinal":{"type":"integer","title":"Group Ordinal","description":"The display ordering of the modifier group at sale time."},"name":{"type":"string","title":"Name","description":"The display name of the modifier at sale time."},"variant_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Variant Id","description":"The unique identifier of the linked variant, when the source modifier was of type `product`. May reference a variant that has since been deleted."},"price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"The price applied by the modifier on the line item. `null` for free or note-style modifiers."},"ordinal":{"type":"integer","title":"Ordinal","description":"The display ordering of the modifier within its group at sale time."}},"type":"object","required":["id","modifier_id","group_name","group_ordinal","name","variant_id","price","ordinal"],"title":"OrderLineItemModifier","description":"A modifier selection captured on an order line item at the time of sale.\n\nThis is a point-in-time snapshot, not a live view of the catalogue. Display fields —\n`group_name`, `name`, and `price` — reflect what the customer was charged and shown\nwhen the sale was processed, even if the underlying modifier or its group has been\nrenamed or deleted since. `modifier_id` is a best-effort reference back to the source\n`Modifier`; the owning modifier group is reachable via `Modifier.modifier_group_id` on\nthe resolved modifier when it still exists.","example":{"group_name":"Side Orders","group_ordinal":1,"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","name":"Chips","ordinal":1,"price":{"amount":500,"currency":"ZAR"},"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}},"OrderPaymentMethod":{"type":"string","enum":["cash","other"],"title":"OrderPaymentMethod","description":"How a payment you have already collected was tendered.\n\nUse `cash` when the customer paid in cash, and `other` for any payment taken through a\ncustom payment method on your Yoco account, such as a delivery channel or a QR wallet.\n\nA card payment cannot be recorded on an order."},"OrderPricingMode":{"type":"string","enum":["calculated","supplied"],"title":"OrderPricingMode","description":"Who works out an order's total and taxes when it is created.\n\nWith `calculated`, Yoco totals the line items and applies the taxes set up on the merchant's Yoco account.\nWith `supplied`, you send the order's `total_amount` and each line item's `taxes`, and Yoco records them as sent."},"OrderStatus":{"type":"string","enum":["cancelled","completed","open"],"title":"OrderStatus","description":"An order transitions through various states throughout its lifecycle.\n\nAn order is created `completed` when it is paid in full, and `open` otherwise. From `open`, it will move to a\nterminal state which will be one of either `completed` or `cancelled`.\n\nThe following transitions are possible:\n- open -> completed\n- open -> cancelled"},"OrderTaxItem":{"properties":{"name":{"type":"string","title":"Name","description":"A human-readable name for the tax."},"type":{"$ref":"#/components/schemas/TaxType","description":"The type of tax affects the method used to calculate the tax."},"percentage":{"type":"string","title":"Percentage","description":"The tax rate to apply to the taxable amount. For example, `15.00` corresponds to a tax rate of `15%`."},"tax_amount":{"$ref":"#/components/schemas/Money","description":"The amount of tax. On an order created with `pricing_mode` `supplied`, a line item's amount is the one sent, which isn't checked against the tax's `percentage`, and each of the order's `total_taxes` adds up its line items' amounts for that tax."},"scope":{"$ref":"#/components/schemas/TaxScope","description":"The scope that the tax is applicable to."}},"type":"object","required":["name","type","percentage","tax_amount","scope"],"title":"OrderTaxItem","example":{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}},"OrderUpdated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","event_type"],"title":"OrderUpdated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"order.updated","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3"}},"PaginatedResponse_Annotated_Union_ProductItem__ServiceItem___FieldInfo_annotation_NoneType__required_True__discriminator__type____":{"properties":{"data":{"items":{"oneOf":[{"$ref":"#/components/schemas/ProductItem"},{"$ref":"#/components/schemas/ServiceItem"}],"discriminator":{"propertyName":"type","mapping":{"product":"#/components/schemas/ProductItem","service":"#/components/schemas/ServiceItem"}}},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Annotated[Union[ProductItem, ServiceItem], FieldInfo(annotation=NoneType, required=True, discriminator='type')]]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_CardMachine_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/CardMachine"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[CardMachine]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_ItemBrand_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ItemBrand"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[ItemBrand]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_ItemCategory_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ItemCategory"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[ItemCategory]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Location_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Location"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Location]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_ModifierGroup_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ModifierGroup"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[ModifierGroup]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Order_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Order"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Order]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_PaymentLink_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PaymentLink"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[PaymentLink]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Payment_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Payment"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Payment]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_PayoutEntry_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PayoutEntry"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[PayoutEntry]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Payout_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Payout"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Payout]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Refund_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Refund]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Staff_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Staff"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Staff]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_Tax_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/Tax"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[Tax]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PaginatedResponse_WebhookSubscription_":{"properties":{"data":{"items":{"$ref":"#/components/schemas/WebhookSubscription"},"type":"array","title":"Data","description":"A list of paginated entities."},"next_cursor":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Next Cursor","description":"A pagination cursor that can be used to retrieve the next set of results."}},"type":"object","required":["data","next_cursor"],"title":"PaginatedResponse[WebhookSubscription]","example":{"data":[],"next_cursor":"1323935095007282836"}},"PanEntryMode":{"type":"string","enum":["bar_code","chip_with_cvv","chip_without_cvv","contactless_icc","contactless_mag_stripe","mag_stripe_with_cvv","magnetic_stripe","manual","ocr","unknown"],"title":"PanEntryMode"},"ParentItemCategory":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the category."},"name":{"type":"string","title":"Name","description":"The name of the category."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the category."},"image":{"anyOf":[{"$ref":"#/components/schemas/Media"},{"type":"null"}],"description":"The image to show in the Yoco Point of Sale (POS) app."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The category creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the category was last modified in ISO 8601 format."}},"type":"object","required":["id","name","description","image","created_at","updated_at"],"title":"ParentItemCategory","example":{"created_at":"2024-11-19T15:27:02+00:00","description":"A home for all our beverages.","id":"1757511225824-ab79f3ee-5a21-4bca-a060-ef27d9aae788","image":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"},"name":"Beverages","updated_at":"2024-11-19T16:27:23+00:00"}},"Payment":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the payment."},"client_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Transaction Id","description":"The identifier provided when creating the transaction via the SDK."},"display_name":{"type":"string","title":"Display Name","description":"A human-friendly label for the payment."},"receipt_number":{"type":"string","title":"Receipt Number","description":"The receipt number of the payment."},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id","description":"A reference to the original order."},"staff_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staff Id","description":"The unique identifier of the staff member who took the payment. Matches the `id` returned by the Staff API. `null` when no staff member is associated with the payment."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The payment creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the payment was last modified in ISO 8601 format."},"currency":{"type":"string","title":"Currency","description":"The currency code in ISO 4217 format."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"An optional note attached to the payment."},"amount_excl_tip":{"$ref":"#/components/schemas/Money","description":"The payment amount excluding the amount designated towards the tip. It includes the payment's `service_charge_amount`."},"tip_amount":{"$ref":"#/components/schemas/Money","description":"The payment amount designated towards the tip."},"service_charge_amount":{"$ref":"#/components/schemas/Money","description":"This payment's share of the order's service charges, not the order's total. While an order is part-paid, its payments' shares cover only the part paid so far. Once an order is paid, its payments' shares add up to the order's `amounts.service_charge_amount`: any rounding remainder goes on one of its payments. `0` when the order has no service charge, or when no share is recorded for the order's payments, as on an order paid before shares were recorded."},"total_amount":{"$ref":"#/components/schemas/Money","description":"The total payment amount."},"refunded_amount":{"$ref":"#/components/schemas/Money","description":"The amount of this payment that has been refunded, if any."},"status":{"$ref":"#/components/schemas/PaymentStatus","description":"The current state of the payment."},"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":"The method used to make the payment."},"payment_source":{"$ref":"#/components/schemas/PaymentSource","description":"The source of the payment."},"tender":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tender","description":"The name of the merchant's custom payment method the payment was recorded against, as the merchant stored it, such as `SnapScan`. The stored name can differ in case from the `tender` sent when creating the order. A method the merchant has since disabled or deleted keeps its name here. `null` when the payment has no custom payment method, as on a card or cash payment."},"refunds":{"items":{"$ref":"#/components/schemas/Refund"},"type":"array","title":"Refunds","description":"The refunds that have been issued against the payment."},"processing_fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array","title":"Processing Fees","description":"The transaction fees that have been charged against the payment."},"checkout_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Checkout Id","description":"The checkout ID for online payments. Only present for payments from online checkouts."},"external_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"External Id","description":"The customer-defined identifier provided when creating the checkout. Only present for payments from online checkouts when an external ID has been specified."},"card_machine_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Card Machine Id","description":"The unique identifier of the card machine that processed the payment. Only present for payments taken on a card machine."}},"type":"object","required":["id","client_transaction_id","display_name","receipt_number","order_id","created_at","updated_at","currency","note","amount_excl_tip","tip_amount","service_charge_amount","total_amount","refunded_amount","status","payment_method","payment_source","refunds","processing_fees","checkout_id"],"title":"Payment","example":{"amount_excl_tip":{"amount":25000,"currency":"ZAR"},"card_machine_id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","checkout_id":"ch_J2xYWl4m7B6DsKAPCM9SRDEd","client_transaction_id":"5f29b4cf-5650-4c71-b7e5-f70eb892e55f","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Payment receipt #491352","external_id":"order-123","id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","note":"This is a note on this payment.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","payment_method":"card","payment_source":"payment_link","receipt_number":"491352","refunded_amount":{"amount":0,"currency":"ZAR"},"refunds":[{"client_transaction_id":"rfd_765fde5ded7bxd","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Refund receipt #491352","id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","note":"This is a note on this refund.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","payment_method":"card","processed_at":"2024-11-20T16:27:23+00:00","processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"receipt_number":"491352","refund_type":"auth_reversal","refunded_processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","total_amount":{"amount":4500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}],"service_charge_amount":{"amount":1250,"currency":"ZAR"},"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","tip_amount":{"amount":2500,"currency":"ZAR"},"total_amount":{"amount":27500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}},"PaymentCreated":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"payment_id":{"type":"string","title":"Payment Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","payment_id","event_type"],"title":"PaymentCreated","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"payment.created","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3","payment_id":"d2ff5a9a-0998-46e2-aebe-2c72c3ddde1f"}},"PaymentLink":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the payment link."},"url":{"type":"string","title":"Url","description":"The payment link."},"customer_reference":{"type":"string","title":"Customer Reference","description":"The customer's name or reference that will appear on the payment page."},"customer_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Customer Description","description":"An optional description that will appear on the payment page."},"status":{"$ref":"#/components/schemas/PaymentLinkStatus","description":"The current state of the payment link."},"order_id":{"type":"string","title":"Order Id","description":"A reference to the original order."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The payment link creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the payment link was last modified in ISO 8601 format."}},"type":"object","required":["id","url","customer_reference","customer_description","status","order_id","created_at","updated_at"],"title":"PaymentLink","example":{"created_at":"2024-11-19T15:27:02+00:00","customer_description":"This description is visible to the customer on the payment page.","customer_reference":"Peter Parker","id":"1743683416648-616bc018-c572-430b-9c07-4e813ed03eb4","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","status":"pending","updated_at":"2024-11-19T16:27:23+00:00","url":"https://pay.yoco.com/r/dRggEC"}},"PaymentLinkStatus":{"type":"string","enum":["cancelled","paid","pending"],"title":"PaymentLinkStatus","description":"A payment link transitions through various states throughout its lifecycle.\n\nA payment link is always created in a `pending` state.  From there, it will move to a terminal state which will\nbe one of either `paid` or `cancelled`.\n\nThe following transitions are possible:\n- pending -> paid\n- pending -> cancelled"},"PaymentMethod":{"type":"string","enum":["card","cash","instant_eft","gift_voucher","other"],"title":"PaymentMethod"},"PaymentRefunded":{"properties":{"business_id":{"type":"string","title":"Business Id"},"order_id":{"type":"string","title":"Order Id"},"payment_id":{"type":"string","title":"Payment Id"},"event_type":{"type":"string","title":"Event Type"}},"type":"object","required":["business_id","order_id","payment_id","event_type"],"title":"PaymentRefunded","example":{"business_id":"f3f777bb-ca3c-4638-bc79-8fcf0fd0f8f1","event_type":"payment.refunded","order_id":"e13ed7f6-56a5-42f4-be6b-f87063ffd8f3","payment_id":"d2ff5a9a-0998-46e2-aebe-2c72c3ddde1f"}},"PaymentSource":{"type":"string","enum":["card_machine","checkout","invoice","other","payment_link","shopify","wix","woocommerce"],"title":"PaymentSource"},"PaymentStatus":{"type":"string","enum":["approved","cancelled","failed","pending"],"title":"PaymentStatus"},"Payout":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the payout."},"status":{"$ref":"#/components/schemas/PayoutStatus","description":"The current state of the payout."},"payout_type":{"$ref":"#/components/schemas/PayoutType","description":"The type of payout."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The payout creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the payout was last modified in ISO 8601 format."},"gross_amount":{"$ref":"#/components/schemas/Money","description":"The gross amount of the payout."},"capital_repayment_amount":{"$ref":"#/components/schemas/Money","description":"The amount deducted and paid back towards a cash advance."},"fee_amount":{"$ref":"#/components/schemas/Money","description":"The fee associated with this payout."},"net_amount":{"$ref":"#/components/schemas/Money","description":"The net proceeds of this payout after any fees & deductions."},"payout_fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array","title":"Payout Fees","description":"A list of fees associated with the payout."}},"type":"object","required":["id","status","payout_type","created_at","updated_at","gross_amount","capital_repayment_amount","fee_amount","net_amount","payout_fees"],"title":"Payout","example":{"capital_repayment_amount":{"amount":250,"currency":"ZAR"},"created_at":"2024-11-19T15:27:02+00:00","fee_amount":{"amount":350,"currency":"ZAR"},"gross_amount":{"amount":12000,"currency":"ZAR"},"id":"1744288539-57db0a32-3cae-40af-a328-b22a09cfcb94","net_amount":{"amount":11400,"currency":"ZAR"},"payout_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"payout_type":"standard","status":"paid","updated_at":"2024-11-19T16:27:23+00:00"}},"PayoutEntry":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the payout entry."},"client_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Transaction Id","description":"The identifier provided when creating the transaction via the SDK."},"payout_id":{"type":"string","title":"Payout Id","description":"A reference to the payout that this entry is a part of."},"type":{"$ref":"#/components/schemas/PayoutEntryType","description":"The type of payout entry."},"gross_amount":{"$ref":"#/components/schemas/Money","description":"The gross amount of this payout entry."},"capital_repayment_amount":{"$ref":"#/components/schemas/Money","description":"The amount deducted and paid back towards a cash advance."},"fee_amount":{"$ref":"#/components/schemas/Money","description":"The fee associated with this payout entry."},"net_amount":{"$ref":"#/components/schemas/Money","description":"The net proceeds of this payout entry after any fees & deductions."}},"type":"object","required":["id","client_transaction_id","payout_id","type","gross_amount","capital_repayment_amount","fee_amount","net_amount"],"title":"PayoutEntry","example":{"capital_repayment_amount":{"amount":250,"currency":"ZAR"},"client_transaction_id":"rfd_765fde5ded7bxd","fee_amount":{"amount":350,"currency":"ZAR"},"gross_amount":{"amount":12000,"currency":"ZAR"},"id":"1744289052-a70682ae-7376-404c-9859-3aa100322fa0","net_amount":{"amount":11400,"currency":"ZAR"},"payout_id":"1744288539-57db0a32-3cae-40af-a328-b22a09cfcb94","type":"payment"}},"PayoutEntryType":{"type":"string","enum":["adjustment","capital","dispute","fee","instant_payout","loyalty","payment","refund","rebate"],"title":"PayoutEntryType"},"PayoutStatus":{"type":"string","enum":["failed","paid","sent","unpaid"],"title":"PayoutStatus"},"PayoutType":{"type":"string","enum":["fast","instant","standard","weekly"],"title":"PayoutType"},"PositiveMoney":{"properties":{"amount":{"type":"integer","maximum":2147483647.0,"exclusiveMinimum":0.0,"format":"int32","title":"Amount","description":"The amount of money in the smallest denomination of the currency. For example, when the `currency` is `ZAR`, the `amount` is in cents."},"currency":{"type":"string","maxLength":3,"minLength":3,"title":"Currency","description":"The currency code in ISO 4217 format."}},"type":"object","required":["amount","currency"],"title":"PositiveMoney","description":"`PositiveMoney` is a `Money` whose amount is greater than zero.","example":{"amount":1500,"currency":"ZAR"}},"PricingStrategy":{"type":"string","enum":["fixed_price","free","product"],"title":"PricingStrategy","description":"`PricingStrategy` determines how the price of a modifier is calculated when applied to an item.\n\n- `free`: the modifier does not change the price of the item.\n- `fixed_price`: the modifier applies the price set in `fixed_price`.\n- `product`: the modifier inherits the price of its linked item variant (`variant_id`).\n  Available only on `product` modifiers."},"ProductItem":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the item."},"name":{"type":"string","title":"Name","description":"The name of the item."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the item."},"default_price":{"$ref":"#/components/schemas/Money","description":"The default price of the item."},"default_barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Barcode","description":"The barcode set on the item itself. Variants without a barcode of their own report this value as their `barcode`."},"default_cost_price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"What the merchant pays for one unit of the item."},"default_duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Duration","description":"The duration of the service, in minutes."},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether tax is charged when the item is sold. An item with no taxes of its own is charged the business's default tax. `false` when every tax that applies has a rate of 0%, so a zero-rated item and an exempt item both report `false`."},"taxes":{"items":{"$ref":"#/components/schemas/ItemTax"},"type":"array","title":"Taxes","description":"The item's own taxes, set with `tax_ids`. Empty when the business's default tax applies to the item."},"images":{"items":{"$ref":"#/components/schemas/Media"},"type":"array","title":"Images","description":"A list of images associated with the item."},"category_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Id","description":"The unique identifier of the category the item belongs to."},"category":{"anyOf":[{"$ref":"#/components/schemas/ItemCategory"},{"type":"null"}],"description":"The category the item belongs to. Only populated when `category` is requested via the `expand` query parameter."},"options":{"items":{"$ref":"#/components/schemas/ItemOption"},"type":"array","title":"Options","description":"The item options associated with the item."},"has_multiple_variants":{"type":"boolean","title":"Has Multiple Variants","description":"Whether the item has more than one variant."},"variants":{"items":{"$ref":"#/components/schemas/ItemVariant"},"type":"array","title":"Variants","description":"The variants of the item."},"stock_tracking":{"$ref":"#/components/schemas/StockTracking","description":"Whether the Yoco Point of Sale (POS) app tracks stock for the item: `none` doesn't track stock, `item` keeps one count shared by all of the item's variants, and `variant` keeps a separate count for each variant."},"modifier_groups":{"items":{"$ref":"#/components/schemas/ItemModifierGroup"},"type":"array","title":"Modifier Groups","description":"The modifier groups attached to this item."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The item creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the item was last modified in ISO 8601 format."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/ItemLocationAvailability"},{"type":"null"}],"description":"The location availability configuration for this item. Present when `location_availability` is requested via the `expand` query parameter, and always on create and update responses."},"price_overrides":{"anyOf":[{"items":{"$ref":"#/components/schemas/ItemPriceOverride"},"type":"array"},{"type":"null"}],"title":"Price Overrides","description":"The location-specific price overrides for this item's default price. Present when `price_overrides` is requested via the `expand` query parameter, and always on create and update responses."},"type":{"type":"string","const":"product","title":"Type","description":"Discriminator value identifying this item as a physical product."},"brand_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Brand Id","description":"The unique identifier of the brand the product belongs to."},"brand":{"anyOf":[{"$ref":"#/components/schemas/ItemBrand"},{"type":"null"}],"description":"The brand of the product. Only populated when `brand` is requested via the `expand` query parameter."}},"type":"object","required":["id","name","description","default_price","default_barcode","default_cost_price","default_duration","is_taxable","category_id","has_multiple_variants","stock_tracking","created_at","updated_at","type","brand_id"],"title":"ProductItem","example":{"brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337","category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","created_at":"2024-11-19T15:27:02+00:00","default_barcode":"6009800000015","default_cost_price":{"amount":1200,"currency":"ZAR"},"default_price":{"amount":3800,"currency":"ZAR"},"description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","has_multiple_variants":false,"id":"1584347797665-e75edf46-394c-446a-8d25-5a6e0f244cef","images":[{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"}],"is_taxable":true,"modifier_groups":[],"name":"Flat White","options":[],"stock_tracking":"item","taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","percentage":"15.00","type":"inclusive"}],"type":"product","updated_at":"2024-11-19T16:27:23+00:00","variants":[]}},"Refund":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the refund."},"client_transaction_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Transaction Id","description":"The identifier provided when creating the transaction via the SDK."},"display_name":{"type":"string","title":"Display Name","description":"A human-friendly label for the refund."},"receipt_number":{"type":"string","title":"Receipt Number","description":"The receipt number of the refund."},"payment_id":{"type":"string","title":"Payment Id","description":"A reference to the original payment."},"order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Id","description":"A reference to the refund order."},"staff_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staff Id","description":"The unique identifier of the staff member who processed the refund. Matches the `id` returned by the Staff API. `null` when no staff member is associated with the refund."},"original_order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Order Id","description":"A reference to the original order."},"order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Order Number","description":"A human-friendly identifier for the refund order."},"original_order_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Original Order Number","description":"A human-friendly identifier for the original order."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The refund creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the refund was last modified in ISO 8601 format."},"currency":{"type":"string","title":"Currency","description":"The currency code in ISO 4217 format."},"note":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Note","description":"An optional note attached to the refund."},"total_amount":{"$ref":"#/components/schemas/Money","description":"The amount of money refunded to the buyer."},"status":{"$ref":"#/components/schemas/RefundStatus","description":"The current state of the refund."},"processing_fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array","title":"Processing Fees","description":"The transaction fees that have been charged against the refund."},"processed_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Processed At","description":"The date and time the refund was processed in ISO 8601 format."},"payment_method":{"$ref":"#/components/schemas/PaymentMethod","description":"The method used to refund the payment."},"refunded_processing_fees":{"items":{"$ref":"#/components/schemas/Fee"},"type":"array","title":"Refunded Processing Fees","description":"The transaction fees that have been refunded."},"refund_type":{"$ref":"#/components/schemas/RefundType","description":"The type of refund."}},"type":"object","required":["id","client_transaction_id","display_name","receipt_number","payment_id","order_id","original_order_id","order_number","original_order_number","created_at","updated_at","currency","note","total_amount","status","processing_fees","processed_at","payment_method","refunded_processing_fees","refund_type"],"title":"Refund","example":{"client_transaction_id":"rfd_765fde5ded7bxd","created_at":"2024-11-19T15:27:02+00:00","currency":"ZAR","display_name":"Refund receipt #491352","id":"1732188199292-2a8752ab-db45-4507-9d85-fcc6049beef3","note":"This is a note on this refund.","order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d","original_order_number":"10542623","payment_id":"1732194482873-c777dc85-035e-40de-9820-765fde5ded7b","payment_method":"card","processed_at":"2024-11-20T16:27:23+00:00","processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"receipt_number":"491352","refund_type":"auth_reversal","refunded_processing_fees":[{"amount":{"amount":27800,"currency":"ZAR"},"type":"initial"}],"staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","status":"approved","total_amount":{"amount":4500,"currency":"ZAR"},"updated_at":"2024-11-19T16:27:23+00:00"}},"RefundStatus":{"type":"string","enum":["approved","failed","pending","rejected"],"title":"RefundStatus"},"RefundType":{"type":"string","enum":["auth_reversal","credit_return","other"],"title":"RefundType"},"Return":{"properties":{"returned_line_items":{"items":{"$ref":"#/components/schemas/OrderLineItem"},"type":"array","title":"Returned Line Items","description":"A list of line items from the original order that have been returned."},"returned_total_taxes":{"items":{"$ref":"#/components/schemas/OrderTaxItem"},"type":"array","title":"Returned Total Taxes","description":"A list of returned taxes across all line items, one entry per sales tax. Two sales taxes can share a name."},"returned_applied_discounts":{"items":{"$ref":"#/components/schemas/DiscountItem"},"type":"array","title":"Returned Applied Discounts","description":"The discounts applicable to the return."},"source_order_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Order Id","description":"The unique identifier of the original order that this return was created from."},"amounts":{"$ref":"#/components/schemas/OrderAmounts","description":"A collection of summarized amounts on the return."}},"type":"object","required":["returned_line_items","returned_total_taxes","returned_applied_discounts","source_order_id","amounts"],"title":"Return","example":{"amounts":{"discount_amount":{"amount":2780,"currency":"ZAR"},"gross_amount":{"amount":16680,"currency":"ZAR"},"net_amount":{"amount":13900,"currency":"ZAR"},"service_charge_amount":{"amount":0,"currency":"ZAR"},"tax_amount":{"amount":32263,"currency":"ZAR"},"tip_amount":{"amount":0,"currency":"ZAR"}},"returned_applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"returned_line_items":[{"applied_discounts":[{"discount_amount":{"amount":3000,"currency":"ZAR"},"name":"Item Discount","percentage":"10.00","scope":"order","type":"fixed_percentage"}],"applied_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"discount_amount":{"amount":2780,"currency":"ZAR"},"id":"1585232943683-bc402745-df17-486e-b583-3dfedcbc8b53","item_type":"product","modifiers":[{"group_name":"Side Orders","group_ordinal":1,"id":"1729101234567-bem-aa11-4bbb-9ccc-112233445566","modifier_id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","name":"Chips","ordinal":1,"price":{"amount":500,"currency":"ZAR"},"variant_id":"1719321844551-c61b8a54-902e-4f3d-9d70-8b1e2f5b1a90:small"}],"name":"Men's Funky Blue T-Shirt - Medium","net_amount":{"amount":25020,"currency":"ZAR"},"note":"This is an optional note related to this item in the order.","quantity":"1.000","staff_id":"1739522553-a7769044-ff8c-410d-b660-84e6727c70b9","total_price":{"amount":13900,"currency":"ZAR"},"unit_price":{"amount":13900,"currency":"ZAR"},"variant_id":"1600421176247-798d940c-fce6-44b2-9872-8bb28005ec2a:1718365491897-f6a94fdc-46e4-477f-9b53-be85e35fc7a6"}],"returned_total_taxes":[{"name":"VAT","percentage":"15.00","scope":"line_item","tax_amount":{"amount":3000,"currency":"ZAR"},"type":"inclusive"}],"source_order_id":"1585232943682-9f7e2dbe-a09e-4fa8-aa4a-72290c513f1d"}},"RotateWebhookSubscriptionSecretResponse":{"properties":{"secret":{"type":"string","title":"Secret","description":"The new secret used to verify the payload of a webhook."}},"type":"object","required":["secret"],"title":"RotateWebhookSubscriptionSecretResponse","example":{"secret":"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD"}},"SelectedOption":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the item option."},"value":{"type":"string","title":"Value","description":"The value of the option for this variant."}},"type":"object","required":["name","value"],"title":"SelectedOption","example":{"name":"Size","value":"Small"}},"SendTestWebhookEventRequest":{"properties":{"event_type":{"$ref":"#/components/schemas/WebhookEventType","description":"The event type to send."}},"type":"object","required":["event_type"],"title":"SendTestWebhookEventRequest","example":{"event_type":"payment.created"}},"SendTestWebhookEventResponse":{"properties":{"message_id":{"type":"string","title":"Message Id","description":"The unique message identifier of the webhook event."}},"type":"object","required":["message_id"],"title":"SendTestWebhookEventResponse","example":{"message_id":"msg_1srOrx2ZWZBpBUvZwXKQmoEYga2"}},"ServiceChargeItem":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the service charge."},"name":{"type":"string","title":"Name","description":"A human-readable name for the service charge."},"amount":{"$ref":"#/components/schemas/Money","description":"The amount of the service charge."}},"type":"object","required":["id","name","amount"],"title":"ServiceChargeItem","example":{"amount":{"amount":2500,"currency":"ZAR"},"id":"1585232943682-b3f0a1c2-9d4e-4f6a-8b1c-2d3e4f5a6b7c","name":"Delivery fee"}},"ServiceItem":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the item."},"name":{"type":"string","title":"Name","description":"The name of the item."},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"A description of the item."},"default_price":{"$ref":"#/components/schemas/Money","description":"The default price of the item."},"default_barcode":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Default Barcode","description":"The barcode set on the item itself. Variants without a barcode of their own report this value as their `barcode`."},"default_cost_price":{"anyOf":[{"$ref":"#/components/schemas/Money"},{"type":"null"}],"description":"What the merchant pays for one unit of the item."},"default_duration":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Default Duration","description":"The duration of the service, in minutes."},"is_taxable":{"type":"boolean","title":"Is Taxable","description":"Whether tax is charged when the item is sold. An item with no taxes of its own is charged the business's default tax. `false` when every tax that applies has a rate of 0%, so a zero-rated item and an exempt item both report `false`."},"taxes":{"items":{"$ref":"#/components/schemas/ItemTax"},"type":"array","title":"Taxes","description":"The item's own taxes, set with `tax_ids`. Empty when the business's default tax applies to the item."},"images":{"items":{"$ref":"#/components/schemas/Media"},"type":"array","title":"Images","description":"A list of images associated with the item."},"category_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Category Id","description":"The unique identifier of the category the item belongs to."},"category":{"anyOf":[{"$ref":"#/components/schemas/ItemCategory"},{"type":"null"}],"description":"The category the item belongs to. Only populated when `category` is requested via the `expand` query parameter."},"options":{"items":{"$ref":"#/components/schemas/ItemOption"},"type":"array","title":"Options","description":"The item options associated with the item."},"has_multiple_variants":{"type":"boolean","title":"Has Multiple Variants","description":"Whether the item has more than one variant."},"variants":{"items":{"$ref":"#/components/schemas/ItemVariant"},"type":"array","title":"Variants","description":"The variants of the item."},"stock_tracking":{"$ref":"#/components/schemas/StockTracking","description":"Whether the Yoco Point of Sale (POS) app tracks stock for the item: `none` doesn't track stock, `item` keeps one count shared by all of the item's variants, and `variant` keeps a separate count for each variant."},"modifier_groups":{"items":{"$ref":"#/components/schemas/ItemModifierGroup"},"type":"array","title":"Modifier Groups","description":"The modifier groups attached to this item."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The item creation date and time in ISO 8601 format."},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At","description":"The date and time the item was last modified in ISO 8601 format."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/ItemLocationAvailability"},{"type":"null"}],"description":"The location availability configuration for this item. Present when `location_availability` is requested via the `expand` query parameter, and always on create and update responses."},"price_overrides":{"anyOf":[{"items":{"$ref":"#/components/schemas/ItemPriceOverride"},"type":"array"},{"type":"null"}],"title":"Price Overrides","description":"The location-specific price overrides for this item's default price. Present when `price_overrides` is requested via the `expand` query parameter, and always on create and update responses."},"type":{"type":"string","const":"service","title":"Type","description":"Discriminator value identifying this item as a service."}},"type":"object","required":["id","name","description","default_price","default_barcode","default_cost_price","default_duration","is_taxable","category_id","has_multiple_variants","stock_tracking","created_at","updated_at","type"],"title":"ServiceItem","example":{"category_id":"1742394821447-c5f1a902-6d77-4f14-bbe2-09d2c4fa5e88","created_at":"2024-11-19T15:27:02+00:00","default_barcode":"6009800000039","default_cost_price":{"amount":8000,"currency":"ZAR"},"default_duration":30,"default_price":{"amount":25000,"currency":"ZAR"},"description":"A classic men's haircut and style finish, including a wash and blow-dry.","has_multiple_variants":false,"id":"1742394820001-a27d3f6e-4b18-4c92-9e51-2a8fbb4d31c7","images":[{"created_at":"2024-11-19T15:27:02+00:00","id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","mime_type":"image/jpeg","type":"image","updated_at":"2024-11-19T16:27:23+00:00","url":"https://images.yoco.com/foo/bar.jpg"}],"is_taxable":true,"modifier_groups":[],"name":"Men's Haircut","options":[],"stock_tracking":"none","taxes":[{"id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","name":"VAT","percentage":"15.00","type":"inclusive"}],"type":"service","updated_at":"2024-11-19T16:27:23+00:00","variants":[]}},"Staff":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the staff member."},"staff_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Staff Number","description":"The staff number set by an external system, such as a point-of-sale integration, used to reconcile this staff member to that system. `null` when no external staff number has been recorded."},"role":{"$ref":"#/components/schemas/StaffRole","description":"The role of the staff member within the business."},"status":{"$ref":"#/components/schemas/StaffStatus","description":"Whether the staff member is currently active in the business. A removed staff member is returned as `inactive` so that historical records referencing them can still be resolved."},"first_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Name","description":"The first name of the staff member."},"last_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Name","description":"The last name of the staff member."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The date and time the staff member was added to the business in ISO 8601 format."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The date and time the staff member was last updated in ISO 8601 format."},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At","description":"The date and time the staff member was removed from the business in ISO 8601 format, or `null` if they are still active."}},"type":"object","required":["id","role","status","first_name","last_name","created_at","updated_at"],"title":"Staff","example":{"created_at":"2024-11-19T15:27:02+00:00","first_name":"Jane","id":"1739522545-45b6b5d8-897f-4a00-86f4-a7e9b315934f","last_name":"Doe","role":"manager","staff_number":"1234","status":"active","updated_at":"2024-11-19T15:27:02+00:00"}},"StaffRole":{"type":"string","enum":["administrator","custom","manager","staff_member","supervisor"],"title":"StaffRole"},"StaffStatus":{"type":"string","enum":["active","inactive"],"title":"StaffStatus"},"StockTracking":{"type":"string","enum":["item","none","variant"],"title":"StockTracking","description":"`StockTracking` is whether the Yoco Point of Sale (POS) app tracks stock for an item.\n\n`none` doesn't track stock. `item` keeps one count shared by all of the item's variants.\n`variant` keeps a separate count for each variant."},"Tax":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the tax."},"name":{"type":"string","title":"Name","description":"A human-readable name for the tax."},"type":{"$ref":"#/components/schemas/TaxType","description":"The type of tax affects the method used to calculate the tax."},"percentage":{"type":"string","title":"Percentage","description":"The tax rate. For example, `15.00` corresponds to a tax rate of `15%`."},"is_default":{"type":"boolean","title":"Is Default","description":"Whether this is the business's default tax. An item with no taxes of its own is charged the default tax. The merchant chooses the default tax in the Yoco app."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The tax creation date and time in ISO 8601 format."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The date and time the tax was last modified in ISO 8601 format."}},"type":"object","required":["id","name","type","percentage","is_default","created_at","updated_at"],"title":"Tax","example":{"created_at":"2024-11-19T15:27:02+00:00","id":"1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852","is_default":true,"name":"VAT","percentage":"15.00","type":"inclusive","updated_at":"2024-11-19T16:27:23+00:00"}},"TaxScope":{"type":"string","enum":["line_item","order"],"title":"TaxScope","description":"`TaxScope` can be either `order` or `line_item` and indicates whether the given tax is applicable to\nthe entire order, or just a particular line item in the order."},"TaxType":{"type":"string","enum":["additive","inclusive"],"title":"TaxType","description":"`TaxType` can be either `additive` or `inclusive` and affects how tax is calculated.\n\nFor `additive` tax, the tax is calculated on top of the price. For example, an item which costs R100.00 with a 15%\nadditive tax has a total cost to the buyer of R115.00 (R100.00 * 1.15). The tax amount is therefore\nR115.00 - R100.00 = R15.00.\n\nFor `inclusive` tax, the tax is included in the price. For example, an item which costs R115.00 with a 15%\ninclusive tax has a total cost to the buyer of R115.00. The tax amount is R15.00 (R115.00 * 15/115) whilst the\ntaxable amount is R100 (R115.00 - R15.00)."},"Terminal":{"properties":{"model":{"type":"string","title":"Model","description":"Payment terminal model name."},"serial_number":{"type":"string","title":"Serial Number","description":"Terminal's unique serial number."}},"type":"object","required":["model","serial_number"],"title":"Terminal","example":{"model":"Neo Touch","serial_number":"52303251110"}},"UpdateItemBrandRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the brand. Leading and trailing whitespace is removed, and the name that remains must be 1 to 255 characters long, and unique among the business's brands."},"description":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Description","description":"A description of the brand. Leading and trailing whitespace is removed, and the description that remains must be 1 to 255 characters long. Send `null` to clear it."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The `id` of the brand's image, a media item uploaded with `POST /v1/media/`. Send `null` to clear it."}},"type":"object","required":["name","description","image_id"],"title":"UpdateItemBrandRequest","description":"`UpdateItemBrandRequest` carries the complete brand, as an update replaces the whole object.\nEvery field is required, and `null` clears a value.","example":{"description":"Everyday products, built to last.","image_id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","name":"Acme"}},"UpdateItemCategoryRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the category. Leading and trailing whitespace is removed, and the name that remains must be 1 to 255 characters long, and unique among the business's categories."},"description":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Description","description":"A description of the category. Leading and trailing whitespace is removed, and the description that remains must be 1 to 255 characters long. Send `null` to clear it."},"parent_category_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Parent Category Id","description":"The unique identifier of the parent category. The parent must be another category of the business. The parent must not sit below this category, and the category cannot be its own parent. Send `null` to remove the parent."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The `id` of a media item uploaded with `POST /v1/media/`, shown as the image of the category. Send `null` to clear the image."}},"type":"object","required":["name","description","parent_category_id","image_id"],"title":"UpdateItemCategoryRequest","description":"`UpdateItemCategoryRequest` carries the complete category, as an update replaces the whole\nobject. Every field is required, and `null` clears a value.","example":{"description":"A home for all our beverages.","image_id":"1757533814961-58f649da-81e3-4877-8769-f407cfba8aff","name":"Beverages","parent_category_id":"1757511225824-ab79f3ee-5a21-4bca-a060-ef27d9aae788"}},"UpdateItemLocationAvailabilityRequest":{"properties":{"is_available_at_all_locations":{"type":"boolean","title":"Is Available At All Locations","description":"Whether the item or variant is available at every location. When `true`, `excluded_location_ids` lists the exceptions. When `false`, `included_location_ids` lists the only locations that sell it."},"included_location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"title":"Included Location Ids","description":"The unique identifiers of the only locations that sell the item or variant. Must be empty when `is_available_at_all_locations` is `true`."},"excluded_location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"title":"Excluded Location Ids","description":"The unique identifiers of the locations that do not sell the item or variant. Must be empty when `is_available_at_all_locations` is `false`."}},"type":"object","required":["is_available_at_all_locations","included_location_ids","excluded_location_ids"],"title":"UpdateItemLocationAvailabilityRequest","description":"`UpdateItemLocationAvailabilityRequest` carries the location availability of an item or variant\nbeing replaced, so every field must be present.","example":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true}},"UpdateItemOptionRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the option, e.g. `Size`."},"values":{"items":{"$ref":"#/components/schemas/UpdateItemOptionValueRequest"},"type":"array","maxItems":100,"minItems":1,"title":"Values","description":"The values the option can take, e.g. `Small` and `Large`."},"id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Id","description":"The unique identifier of an existing option to update in place. Send `null` to create a new option. An existing option left out of the request is removed."}},"type":"object","required":["name","values","id"],"title":"UpdateItemOptionRequest","description":"`UpdateItemOptionRequest` carries an option of an item being replaced.","example":{"name":"Size","values":[{"name":"Small"},{"name":"Large"}]}},"UpdateItemOptionValueRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item option value."}},"type":"object","required":["name"],"title":"UpdateItemOptionValueRequest","description":"`UpdateItemOptionValueRequest` carries a value of an `UpdateItemOptionRequest`.","example":{"name":"Small"}},"UpdateItemPriceOverrideRequest":{"properties":{"price":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The price of the item at these locations."},"location_ids":{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":100,"minItems":1,"title":"Location Ids","description":"The unique identifiers of the locations that charge this price."},"id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Id","description":"The unique identifier of an existing price override to update in place. Send `null` to create a new price override. An existing price override left out of the request is removed."}},"type":"object","required":["price","location_ids","id"],"title":"UpdateItemPriceOverrideRequest","description":"`UpdateItemPriceOverrideRequest` carries a price override of an item being replaced.","example":{"location_ids":["1757511249595-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4200,"currency":"ZAR"}}},"UpdateItemRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item."},"description":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Description","description":"A description of the item."},"default_price":{"$ref":"#/components/schemas/NonNegativeMoney","description":"The default price of the item."},"default_barcode":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Default Barcode","description":"The barcode of the item. A variant without a barcode of its own reports this value as its `barcode`."},"default_cost_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"What the merchant pays for one unit of the item."},"default_duration":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32"},{"type":"null"}],"title":"Default Duration","description":"The duration of the service, in minutes."},"type":{"$ref":"#/components/schemas/ItemType","description":"Whether the item is a physical product or a service."},"stock_tracking":{"$ref":"#/components/schemas/StockTracking","description":"Whether the Yoco Point of Sale (POS) app tracks stock for the item: `none` doesn't track stock, `item` keeps one count shared by all of the item's variants, and `variant` keeps a separate count for each variant. Defaults to `none` when you create an item, and can't be `null`.\n\nChanging this can delete stock data. Switching to `none` deletes the item's stock counts and low stock alert levels. Switching from `variant` to `item` deletes each variant's count, alert level and own SKU, so every variant reports the item's SKU. Switching from `item` to `variant` starts each variant without a count and with the item's alert level. Sending the value the item already has leaves its counts, alert levels and SKUs as they are."},"category_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Category Id","description":"The unique identifier of the category the item belongs to."},"brand_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Brand Id","description":"The unique identifier of the brand the item belongs to. Only a `product` can belong to a brand, so a `service` may leave it out."},"image_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Image Id","description":"The unique identifier of the item's image: the `id` of a media item uploaded with `POST /v1/media/`."},"tax_ids":{"anyOf":[{"items":{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},"type":"array","maxItems":10},{"type":"null"}],"title":"Tax Ids","description":"The unique identifiers of the taxes to apply to the item. `null` or `[]` removes the item's own taxes, so the business's default tax applies. To charge no tax, send the id of a tax from `GET /v1/taxes` whose `percentage` is `0`, such as No Tax if the business has one."},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateItemOptionRequest"},"type":"array","maxItems":3},{"type":"null"}],"title":"Options","description":"The options the item varies by, e.g. `Size`. An item with options needs one variant for every combination of their values. Send `[]` or `null` for an item without options."},"variants":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateItemVariantRequest"},"type":"array","maxItems":250},{"type":"null"}],"title":"Variants","description":"The purchasable variants of the item, one for every combination of the item's `options` values. Send `[]` or `null` for an item without variants."},"price_overrides":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateItemPriceOverrideRequest"},"type":"array","maxItems":100},{"type":"null"}],"title":"Price Overrides","description":"The prices the item charges at specific locations, in place of its `default_price`. A location may have only one price override. Send `[]` or `null` to remove every price override from the item."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/UpdateItemLocationAvailabilityRequest"},{"type":"null"}],"description":"The locations that sell the item. Send `null` to make the item available at every location."},"modifier_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachItemModifierGroupRequest"},"type":"array","maxItems":50},{"type":"null"}],"title":"Modifier Groups","description":"The modifier groups attached to the item, which apply to every variant. Each group may be attached once, and each `ordinal` used once. Send `[]` or `null` to detach every group."}},"type":"object","required":["name","description","default_price","default_barcode","default_cost_price","default_duration","type","stock_tracking","category_id","image_id","tax_ids","options","variants","price_overrides","location_availability","modifier_groups"],"title":"UpdateItemRequest","description":"`UpdateItemRequest` replaces the whole item, so every field the item carries must be present.\n`null` clears an optional field. Only a `product` can belong to a brand, so a `service` may\nleave out `brand_id`.","example":{"brand_id":"1757511249592-ab46acf9-7c86-4ee0-92b9-6b43e1429337","category_id":"1757511249593-dd25e17c-5541-4276-a078-8c3dcca296de","default_barcode":"6001234567890","default_cost_price":{"amount":1200,"currency":"ZAR"},"default_price":{"amount":1500,"currency":"ZAR"},"description":"A rich espresso with silky steamed milk and microfoam, smooth and balanced.","image_id":"1757511249595-8b2e4c1d-6a7f-4d93-b5e0-2c9f1a3d7e64","location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"modifier_groups":[{"id":"1729001234567-aa11bb22-3344-4cdd-99ee-1122334455ff","ordinal":0}],"name":"Flat White","options":[{"name":"Size","values":[{"name":"Small"},{"name":"Large"}]}],"price_overrides":[{"location_ids":["1757511249595-9b3f7b3e-3b3f-4b3f-9b3f-3b3f7b3e9b3f"],"price":{"amount":4200,"currency":"ZAR"}}],"stock_tracking":"variant","tax_ids":["1757511249594-3f1c8b7a-2d54-4e19-9c02-7b6de4f1a852"],"type":"product","variants":[{"barcode":"12345678","cost_price":{"amount":1200,"currency":"ZAR"},"is_enabled":true,"location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"price":{"amount":1500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Small"}],"sku":"FW-SML"},{"cost_price":{"amount":1500,"currency":"ZAR"},"is_enabled":true,"price":{"amount":4500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Large"}],"sku":"FW-LRG"}]}},"UpdateItemVariantRequest":{"properties":{"sku":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Sku","description":"The SKU (stock keeping unit) of the variant. Used only when the item tracks stock per variant. Otherwise every variant uses the item's SKU and this value is ignored. When it is used, `null` or an empty string keeps an existing variant's SKU, and a new variant gets a SKU generated from the item's SKU and its option values."},"barcode":{"anyOf":[{"type":"string","maxLength":255},{"type":"null"}],"title":"Barcode","description":"The barcode of the variant."},"price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The price of the variant. Send `null` to charge the item's `default_price`."},"cost_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"What the merchant pays for one unit of the variant. Send `null` to use the item's `default_cost_price`."},"duration":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32"},{"type":"null"}],"title":"Duration","description":"The duration of the service variant, in minutes."},"is_enabled":{"type":"boolean","title":"Is Enabled","description":"Whether the variant is available as a purchase option in the Yoco Point of Sale (POS) app."},"selected_options":{"anyOf":[{"items":{"$ref":"#/components/schemas/UpdateSelectedOptionRequest"},"type":"array","maxItems":3},{"type":"null"}],"title":"Selected Options","description":"The option value selected for each of the item's `options`, e.g. `Size` of `Small`. Exactly one value is required per option the item declares. Any order is accepted, and the response lists them in the order of the item's `options`. Send `[]` or `null` for an item without options."},"modifier_groups":{"anyOf":[{"items":{"$ref":"#/components/schemas/AttachItemModifierGroupRequest"},"type":"array"},{"type":"null"}],"title":"Modifier Groups","description":"Must be `[]` or `null`: modifier groups attach to the item, through its `modifier_groups`, and apply to every variant."},"location_availability":{"anyOf":[{"$ref":"#/components/schemas/UpdateItemLocationAvailabilityRequest"},{"type":"null"}],"description":"The locations that sell the variant, stored on the variant and not combined with the item's `location_availability`. Send `null` to make the variant available at every location."},"id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Id","description":"The unique identifier of an existing variant to update in place. Send `null` to create a new variant. An existing variant left out of the request is removed, along with its price overrides and stock tracking."}},"type":"object","required":["sku","barcode","price","cost_price","duration","is_enabled","selected_options","location_availability","id"],"title":"UpdateItemVariantRequest","description":"`UpdateItemVariantRequest` carries a variant of an item being replaced, so every field must\nbe present.","example":{"barcode":"12345678","cost_price":{"amount":1200,"currency":"ZAR"},"is_enabled":true,"location_availability":{"excluded_location_ids":["1757511249596-4c2d8e1f-6a7b-4c9d-8e0f-1a2b3c4d5e6f"],"included_location_ids":[],"is_available_at_all_locations":true},"price":{"amount":1500,"currency":"ZAR"},"selected_options":[{"name":"Size","value":"Small"}],"sku":"FW-SML"}},"UpdateModifierGroupRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the modifier group. It must be unique among the business's modifier groups."},"min_selections":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Min Selections","description":"The minimum number of modifiers that must be selected from the group. A value of `0` means the group is optional."},"max_selections":{"anyOf":[{"type":"integer","maximum":2147483647.0,"minimum":1.0},{"type":"null"}],"format":"int32","title":"Max Selections","description":"The maximum number of modifiers that may be selected from the group. A value of `null` means there is no maximum."},"modifiers":{"items":{"$ref":"#/components/schemas/UpdateModifierRequest"},"type":"array","maxItems":100,"minItems":1,"title":"Modifiers","description":"The complete set of modifiers in the group. A group holds at least one modifier."}},"type":"object","required":["name","min_selections","max_selections","modifiers"],"title":"UpdateModifierGroupRequest","description":"`UpdateModifierGroupRequest` replaces the whole modifier group, so every field is required,\nand `null` clears a value.","example":{"max_selections":1,"min_selections":0,"modifiers":[{"fixed_price":{"amount":1500,"currency":"ZAR"},"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","is_selected_by_default":false,"name":"Chips","ordinal":1,"pricing_strategy":"fixed_price"}],"name":"Side Orders"}},"UpdateModifierRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The display name of the modifier."},"pricing_strategy":{"$ref":"#/components/schemas/PricingStrategy","description":"How the price of the modifier is determined when applied to an item."},"fixed_price":{"anyOf":[{"$ref":"#/components/schemas/NonNegativeMoney"},{"type":"null"}],"description":"The fixed price of the modifier. Required when `pricing_strategy` is `fixed_price`, and `null` when it is `free` or `product`. An amount of `0` is a fixed price of zero."},"is_selected_by_default":{"type":"boolean","title":"Is Selected By Default","description":"Whether the modifier is selected by default when its group is shown to the customer."},"ordinal":{"type":"integer","maximum":2147483647.0,"minimum":0.0,"format":"int32","title":"Ordinal","description":"The display ordering of the modifier within its group. Lower values appear first. Unique within the group."},"variant_id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Variant Id","description":"The unique identifier of the item variant this modifier adds to the item, or `null` when none is linked. Required when `pricing_strategy` is `product`. On an update, `null` removes the link."},"id":{"anyOf":[{"type":"string","maxLength":201,"minLength":1,"pattern":"^[A-Za-z0-9:-]+$"},{"type":"null"}],"title":"Id","description":"The unique identifier of an existing modifier in the group to update in place, or `null` to create a new modifier. An existing modifier left out of the request is removed."}},"type":"object","required":["name","pricing_strategy","fixed_price","is_selected_by_default","ordinal","variant_id","id"],"title":"UpdateModifierRequest","description":"`UpdateModifierRequest` carries one modifier of an `UpdateModifierGroupRequest`. Every field\nis required, and `null` clears a value.","example":{"fixed_price":{"amount":1500,"currency":"ZAR"},"id":"1729001234890-cc33dd44-9876-4123-aabb-2233445566ff","is_selected_by_default":false,"name":"Chips","ordinal":1,"pricing_strategy":"fixed_price"}},"UpdateSelectedOptionRequest":{"properties":{"name":{"type":"string","maxLength":255,"minLength":1,"title":"Name","description":"The name of the item option."},"value":{"type":"string","maxLength":255,"minLength":1,"title":"Value","description":"The value of the option for this variant."}},"type":"object","required":["name","value"],"title":"UpdateSelectedOptionRequest","description":"`UpdateSelectedOptionRequest` carries a selected option of an `UpdateItemVariantRequest`.","example":{"name":"Size","value":"Small"}},"UpdateWebhookSubscriptionRequest":{"properties":{"name":{"anyOf":[{"type":"string","maxLength":255,"minLength":1},{"type":"null"}],"title":"Name","description":"A friendly name to describe the subscription."},"event_types":{"anyOf":[{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","minItems":1},{"type":"null"}],"title":"Event Types","description":"A list of event types to bind the subscription to."},"notification_url":{"anyOf":[{"type":"string","maxLength":2083,"minLength":1,"format":"uri"},{"type":"null"}],"title":"Notification Url","description":"The URL to be notified when an event occurs. It must use HTTPS and point to a public host."},"enabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabled","description":"A flag to enable/disable the subscription."}},"type":"object","title":"UpdateWebhookSubscriptionRequest","example":{"enabled":false}},"UploadMediaRequest":{"properties":{"file":{"type":"string","contentMediaType":"application/octet-stream","title":"File","description":"The image file to upload."},"category":{"$ref":"#/components/schemas/MediaCategory","description":"What the media will be attached to."}},"type":"object","required":["file","category"],"title":"UploadMediaRequest","example":{"category":"catalogue"}},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"WebPOSDevice":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID for the Web POS device."},"name":{"type":"string","title":"Name","description":"The friendly POS device name."}},"type":"object","required":["id","name"],"title":"WebPOSDevice","example":{"id":"4cf28172-3bf5-48cd-8c55-e83e1a976992","name":"My Web POS"}},"WebPOSPayment":{"properties":{"id":{"type":"string","format":"uuid","title":"Id","description":"The unique ID for the Web POS payment. Can be used to fetch Web POS payment."},"status":{"$ref":"#/components/schemas/WebPOSPaymentStatus","description":"The status of the Web POS payment."},"redirect_url":{"type":"string","title":"Redirect Url","description":"The URL that can be loaded into an iFrame, window, or new tab to accept merchant input via their browser. The loaded web application can be used by the merchant to confirm the payment session and monitor its progress."},"webpos_device_id":{"type":"string","format":"uuid","title":"Webpos Device Id","description":"The Web POS Device which created the payment."},"amount":{"$ref":"#/components/schemas/Money","description":"The amount of money to charge the buyer."},"client_reference":{"type":"string","title":"Client Reference","description":"The reference value provided by the host POS when the Web POS payment was created."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The date and time the Web POS payment was created, in ISO 8601 format."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The date and time the Web POS payment was last updated, in ISO 8601 format."},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"The metadata provided by the host POS when the Web POS payment was created."},"terminal":{"anyOf":[{"$ref":"#/components/schemas/Terminal"},{"type":"null"}],"description":"The terminal that's been selected to process this payment. Only available if a terminal has been chosen by an operator or auto-selected."},"payment_details":{"anyOf":[{"$ref":"#/components/schemas/WebPOSPaymentDetails"},{"type":"null"}],"description":"Payment outcome related details. Only available once the terminal has captured card data and submitted to upstream services."}},"type":"object","required":["id","status","redirect_url","webpos_device_id","amount","client_reference","created_at","updated_at"],"title":"WebPOSPayment","example":{"amount":{"amount":200,"currency":"ZAR"},"client_reference":"af4a8c17-5720-4a8b-aab1-4619667eaa02","created_at":"2024-10-31T07:53:29.187Z","id":"9c07e0aa-327d-4d41-a8f0-f2136aa22ff8","metadata":{"foo":"bar"},"payment_details":{"authorization_id":"004681","card_details":{"cardholder_verification_method":"online_pin","masked_pan":"441595******4874","pan_entry_mode":"contactless_icc","scheme":"visa"},"emv_application_info":{"application_identifier":"A0000000031010","application_name":"VISA DEBIT"},"retrieval_reference_number":"061038691660"},"redirect_url":"https://cpw.yoco.com/redirect/payments/9c07e0aa-327d-4d41-a8f0-f2136aa22ff8","status":"successful","terminal":{"model":"Neo Touch","serial_number":"52303251110"},"updated_at":"2024-10-31T07:55:12.984Z","webpos_device_id":"4cf28172-3bf5-48cd-8c55-e83e1a976992"}},"WebPOSPaymentDetails":{"properties":{"authorization_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorization Id","description":"'AuthID' provided by the issuer for the card transaction. Only available if a response is received from upstream banks and issuers."},"retrieval_reference_number":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Retrieval Reference Number","description":"'RRN' used to identify the transaction exchange with the acquirer. Only available if the terminal has submitted card data to upstream services."},"card_details":{"anyOf":[{"$ref":"#/components/schemas/CardDetails"},{"type":"null"}],"description":"Details of the card used to process this payment. Only available if terminal has captured and submitted card data to upstream services."},"emv_application_info":{"anyOf":[{"$ref":"#/components/schemas/EmvApplicationInfo"},{"type":"null"}],"description":"EMV details of the card transaction. Only available if terminal has captured and submitted card data to upstream services."}},"type":"object","title":"WebPOSPaymentDetails","example":{"authorization_id":"004681","card_details":{"cardholder_verification_method":"online_pin","masked_pan":"441595******4874","pan_entry_mode":"contactless_icc","scheme":"visa"},"emv_application_info":{"application_identifier":"A0000000031010","application_name":"VISA DEBIT"},"retrieval_reference_number":"061038691660"}},"WebPOSPaymentStatus":{"type":"string","enum":["failed","pending","successful"],"title":"WebPOSPaymentStatus"},"WebhookEventDefinition":{"properties":{"event_type":{"$ref":"#/components/schemas/WebhookEventType","description":"The type of webhook event."},"name":{"type":"string","title":"Name","description":"A friendly name to describe the event."},"description":{"type":"string","title":"Description","description":"A longer description of the event."}},"type":"object","required":["event_type","name","description"],"title":"WebhookEventDefinition","example":{"description":"A notification sent when a payment is created.","event_type":"payment.created","name":"Payment Created"}},"WebhookEventType":{"type":"string","enum":["item_category.created","item_category.deleted","item_category.updated","item.created","item.deleted","item.updated","order.cancelled","order.completed","order.created","order.updated","payment.created","payment.refunded"],"title":"WebhookEventType"},"WebhookSubscription":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier of the subscription."},"name":{"type":"string","title":"Name","description":"A friendly name to describe the subscription."},"enabled":{"type":"boolean","title":"Enabled","description":"A flag indicating whether the subscription is enabled."},"event_types":{"items":{"$ref":"#/components/schemas/WebhookEventType"},"type":"array","title":"Event Types","description":"A list of event types the subscription is bound to."},"notification_url":{"type":"string","title":"Notification Url","description":"The URL to be notified when an event occurs."},"secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Secret","description":"The secret used to verify the payload of a webhook, only available upon creation."},"created_at":{"type":"string","format":"date-time","title":"Created At","description":"The subscription creation date and time in ISO 8601 format."},"updated_at":{"type":"string","format":"date-time","title":"Updated At","description":"The date and time the subscription was last modified in ISO 8601 format."}},"type":"object","required":["id","name","enabled","event_types","notification_url","secret","created_at","updated_at"],"title":"WebhookSubscription","example":{"created_at":"2024-11-19T15:27:02+00:00","enabled":true,"event_types":["payment.created"],"id":"ep_1srOrx2ZWZBpBUvZwXKQmoEYga2","name":"Example Webhook Subscription","notification_url":"https://webhook.site/1d9d0c3c-c0f9-4def-8cf1-99efb5931eca","secret":"whsec_C2FVsBQIhrscChlQIMV+b5sSYspob7oD","updated_at":"2024-11-19T15:27:02+00:00"}}},"securitySchemes":{"Bearer":{"type":"http","description":"JWT authentication","scheme":"bearer"}}}}