{"openapi":"3.0.0","info":{"description":"SmartPin API","title":"SmartPin Public API","version":"1.3.4","x-api-id":"54b1a324-fe2b-41fe-95de-62380de2174b","x-ibm-name":"smartpin-backend-api"},"servers":[{"url":"https://api.rabobank.nl/api/v1","description":"Production server"}],"paths":{"/availableSettings":{"get":{"parameters":[{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/DefaultSettingResponse"},"type":"array"}}},"description":"A list with available settings"}},"tags":["Settings"],"description":"Get all available settings with their types and possible values","operationId":"getAvailableSettings","summary":"Get available settings"}},"/categories":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"contractId","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryResponse"},"type":"array"}}},"description":"A list of categories"}},"tags":["Categories"],"description":"Get all categories for contract","operationId":"getCategories","summary":"Get all categories for contract"}},"/category":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"201":{"content":{"application/octet-stream":{"schema":{"$ref":"#/components/schemas/CreateCategoryResponse"}}},"description":"The ID of the new category"}},"tags":["Categories"],"description":"Create a new category","operationId":"addCategory","requestBody":{"$ref":"#/components/requestBodies/CategoryRequest"},"summary":"Create a new category"}},"/category/{categoryId}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ID of the category","example":1,"in":"path","name":"categoryId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"No Content"}},"tags":["Categories"],"description":"Removes an existing category","operationId":"removeCategory","summary":"Removes an existing category"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ID of the category","example":123,"in":"path","name":"categoryId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryResponse"}}},"description":"The category"}},"tags":["Categories"],"description":"Get specific category by ID","operationId":"getCategory","summary":"Get specific category"},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ID of the category","example":1,"in":"path","name":"categoryId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"No Content"}},"tags":["Categories"],"description":"Updates an existing category","operationId":"updateCategory","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryRequest"}}},"required":true},"summary":"Updates an existing category"}},"/image/{imageId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The image ID","example":123,"in":"path","name":"imageId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageResponse"}}},"description":"Information about a single image"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageResponse"}}},"description":"Image was not found"}},"tags":["Images"],"description":"Returns information about a single image","operationId":"saveProductImage_1","summary":"Returns information about a single image"}},"/images":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ImageResponse"},"type":"array"}}},"description":"List of all images"}},"tags":["Images"],"description":"Gets a list of all images","operationId":"getImages","summary":"Gets all images"}},"/ledger/{ledgerId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ledger ID","example":123,"in":"path","name":"ledgerId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerResponse"}}},"description":"A specific ledger"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerResponse"}}},"description":"If a ledger could not be found"}},"tags":["Ledgers"],"description":"Gets a specific ledger","operationId":"getLedger","summary":"Gets a ledger"}},"/ledger/{ledgerId}/period/{ledgerPeriodId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ledger ID","example":123,"in":"path","name":"ledgerId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The period ID","example":123,"in":"path","name":"ledgerPeriodId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPeriodResponse"}}},"description":"A ledger period"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPeriodResponse"}}},"description":"If a ledger period could not be found"}},"tags":["Ledgers"],"description":"Gets a ledger period for a specific ledger","operationId":"getLedgerPeriod","summary":"Gets a specific ledger period"}},"/ledger/{ledgerId}/period/{ledgerPeriodId}/event/{ledgerPeriodEventId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ledger ID","example":123,"in":"path","name":"ledgerId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The ledger period ID","example":123,"in":"path","name":"ledgerPeriodId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The ledger period event ID","example":123,"in":"path","name":"ledgerPeriodEventId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LedgerPeriodEventResponse"}}},"description":"A ledger period event"}},"tags":["Ledgers"],"description":"Gets a specif event for a specific ledger period","operationId":"getLedgerPeriodEvent","summary":"Gets all ledger event"}},"/ledger/{ledgerId}/period/{ledgerPeriodId}/events":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ledger ID","example":123,"in":"path","name":"ledgerId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The ledger period ID","example":123,"in":"path","name":"ledgerPeriodId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LedgerPeriodEventResponse"},"type":"array"}}},"description":"A list of ledger periods"}},"tags":["Ledgers"],"description":"Gets a  list of all ledger periods for a specific ledger","operationId":"getLedgerPeriodEvents","summary":"Gets all ledger periods"}},"/ledger/{ledgerId}/periods":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The ledger ID","example":123,"in":"path","name":"ledgerId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LedgerPeriodResponse"},"type":"array"}}},"description":"A list of ledger periods"}},"tags":["Ledgers"],"description":"Gets a list of all ledger periods for a specific ledger","operationId":"getLedgerPeriods","summary":"Gets all ledger periods"}},"/ledgers":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LedgerResponse"},"type":"array"}}},"description":"A list of ledgers"}},"tags":["Ledgers"],"description":"Gets a list of ledgers","operationId":"getLedgers_1","summary":"Gets all ledgers"}},"/oauth/token":{"post":{"parameters":[{"in":"header","name":"Authorization","required":true,"schema":{"type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}},{"in":"header","name":"Accept-Language","required":false,"schema":{"pattern":"^((en|nl)[;\\-_]?.*)|$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OAuth2AccessTokenResponse"}}},"description":"A token"}},"tags":["Authentication"],"description":"Get a token","operationId":"getToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenRequest"}}},"required":true},"summary":"Get a token"}},"/oauth/validate":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"A token"}},"tags":["Authentication"],"description":"Validate a token","operationId":"validateToken","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidateRequest"}}},"required":true},"summary":"Validate a token"}},"/order":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderResponse"}}},"description":"An order"}},"tags":["Orders"],"description":"Creates a new order and returns it, including unique external ID.","operationId":"createOrder","requestBody":{"$ref":"#/components/requestBodies/B2BOrderRequest"},"summary":"Creates a new order."},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"description":"The order has been updated successfully."}},"tags":["Orders"],"description":"Updates an existing order.","operationId":"updateOrder","requestBody":{"$ref":"#/components/requestBodies/B2BOrderRequest"},"summary":"Updates an existing order."}},"/order-groups":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The start date","example":"2022-10-01","in":"query","name":"start_date","required":true,"schema":{"pattern":"^20[0-9]{2}\\-[0-9]{1,2}\\-[0-9]{1,2}$","type":"string"}},{"description":"The end date","example":"2022-10-31","in":"query","name":"end_date","required":false,"schema":{"pattern":"^20[0-9]{2}\\-[0-9]{1,2}\\-[0-9]{1,2}$","type":"string"}},{"description":"Whether to return visible, invisible or all order groups","in":"query","name":"visible","required":false,"schema":{"type":"boolean"}},{"description":"Whether to return order group with a specific third party ID","in":"query","name":"third_party_id","required":false,"schema":{"maxLength":255,"minLength":1,"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderGroupResponse"},"type":"array"}}},"description":"A list of orders"},"403":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderGroupResponse"},"type":"array"}}},"description":"It is forbidden to access the list of order groups"}},"tags":["Order Groups"],"description":"Get a list of order groups, with filters applied.","operationId":"getOrderGroups","summary":"Get a list of order groups"},"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderGroupResponse"}}},"description":"Order group has been created successfully"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderGroupResponse"}}},"description":"Invalid data provided to create an order group"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderGroupResponse"}}},"description":"Forbidden to create an order group"}},"tags":["Order Groups"],"description":"Creates a new order group.","operationId":"createOrderGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/B2BCreateOrderGroupRequest"}}},"required":true},"summary":"Creates a new order group"}},"/order-groups/open":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"Whether to return visible, invisible or all order groups","in":"query","name":"visible","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderGroupResponse"},"type":"array"}}},"description":"A list of orders"},"403":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderGroupResponse"},"type":"array"}}},"description":"It is forbidden to access the list of open order groups"}},"tags":["Order Groups"],"description":"Get a list of order groups, with filters applied.","operationId":"getOpenOrderGroups","summary":"Get a list of order groups"}},"/order-groups/third-party-id/check":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckThirdPartyIdResponse"}}},"description":"The availability of a third party id"},"400":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckThirdPartyIdResponse"}}},"description":"Invalid data provided"}},"tags":["Order Groups"],"description":"Checks for the availability of a third party id.","operationId":"checkThirdPartyId","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckThirdPartyIdRequest"}}},"required":true},"summary":"Checks for the availability of a third party id."}},"/order-groups/{orderGroupId}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The language","example":"nl, en","in":"header","name":"Accept-Language","required":false,"schema":{"pattern":"^((en|nl)[;\\-_]?.*)|$","type":"string"}},{"description":"The order group ID","example":123,"in":"path","name":"orderGroupId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group has been deleted or closed successfully"},"403":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Forbidden to delete or closed an order group"},"404":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group does not exist"}},"tags":["Order Groups"],"description":"Deletes or closes an existing order group.","operationId":"deleteOrCloseOrderGroup","summary":"Deletes or closes an existing order group"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The order group ID","example":123,"in":"path","name":"orderGroupId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGroupResponse"}}},"description":"The specific order group"},"403":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGroupResponse"}}},"description":"It is forbidden to access the specific order group"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGroupResponse"}}},"description":"The order group does not exist"}},"tags":["Order Groups"],"description":"Get a specific order group.","operationId":"getOrderGroup","summary":"Get a specific order group"},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The order group ID","example":123,"in":"path","name":"orderGroupId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group has been updated successfully"},"400":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Invalid data provided to update an order group"},"403":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Forbidden to update an order group"},"404":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group does not exist"}},"tags":["Order Groups"],"description":"Updates an existing order group.","operationId":"updateOrderGroup","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/B2BUpdateOrderGroupRequest"}}},"required":true},"summary":"Updates an existing order group"}},"/order-groups/{orderGroupId}/close":{"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The language","example":"nl, en","in":"header","name":"Accept-Language","required":false,"schema":{"pattern":"^((en|nl)[;\\-_]?.*)|$","type":"string"}},{"description":"The order group ID","example":123,"in":"path","name":"orderGroupId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group has been updated successfully"},"400":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Invalid data provided to update an order group"},"403":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Forbidden to update an order group"},"404":{"content":{"application/json":{"schema":{"type":"object"}}},"description":"Order group does not exist"}},"tags":["Order Groups"],"description":"Updates an existing order group.","operationId":"closeOrderGroup","summary":"Updates an existing order group"}},"/order/for-external-id/{orderId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The external order ID","example":"jh4hj5hj5hj4h5j","in":"path","name":"orderId","required":true,"schema":{"type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"An order"}},"tags":["Orders"],"description":"Get a specific order.","operationId":"getOrderByExternalId","summary":"Get a specific order"}},"/order/for-id/{orderId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The order ID","example":1234,"in":"path","name":"orderId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"An order"}},"tags":["Orders"],"description":"Get a specific order.","operationId":"getOrder_1","summary":"Get a specific order"}},"/order/{orderId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The order ID","example":1234,"in":"path","name":"orderId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}},"description":"An order"}},"tags":["Orders"],"description":"Get a specific order.","operationId":"getOrder","summary":"Get a specific order"}},"/orders":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"A start date","example":"2019-01-01","in":"query","name":"start_date","required":true,"schema":{"pattern":"^20[0-9]{2}\\-[0-9]{1,2}\\-[0-9]{1,2}$","type":"string"}},{"description":"An end date (inclusive)","example":"2019-01-31","in":"query","name":"end_date","required":true,"schema":{"pattern":"^20[0-9]{2}\\-[0-9]{1,2}\\-[0-9]{1,2}$","type":"string"}},{"description":"The offset when paginating","example":1000,"in":"query","name":"offset","required":false,"schema":{"format":"int32","type":"integer"}},{"description":"The limit when paginating","example":30,"in":"query","name":"limit","required":false,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/OrderResponse"},"type":"array"}}},"description":"A list of orders"}},"tags":["Orders"],"description":"Get a list of orders, with filters applied.","operationId":"getOrders","summary":"Get a list of orders"}},"/product":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"204":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductResponse"}}},"description":"The product has been successfully created"}},"tags":["Products"],"description":"Create a new product.","operationId":"addProduct","requestBody":{"$ref":"#/components/requestBodies/ProductRequest"},"summary":"Create a new product"}},"/product/{productId}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The product ID","example":123,"in":"path","name":"productId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The product has been successfully deleted."}},"tags":["Products"],"description":"Delete an existing product.","operationId":"deleteProduct","summary":"Delete a product"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The product ID","example":123,"in":"path","name":"productId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponse"}}},"description":"A specific product"}},"tags":["Products"],"description":"Get a specific product.","operationId":"getProduct","summary":"Get a specific product"},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The product ID","example":123,"in":"path","name":"productId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"201":{"description":"The product has been successfully updated"}},"tags":["Products"],"description":"Update an existing product.","operationId":"updateProduct","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductRequest"}}},"required":true},"summary":"Update an existing product"}},"/product/{productId}/image":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The product ID","example":123,"in":"path","name":"productId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"Product image is successfully deleted"}},"tags":["Products"],"description":"Delete a product image","operationId":"deleteProductImage","summary":"Delete a product image"},"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The product ID","example":1,"in":"path","name":"productId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImageResponse"}}},"description":"A product images has been created successfully"}},"tags":["Products"],"description":"Create a product image","operationId":"saveProductImage","requestBody":{"content":{"multipart/form-data":{"schema":{"properties":{"file":{"description":"The image file","format":"binary","type":"string"}},"required":["file"],"type":"object"}}}},"summary":"Create a product image"}},"/products":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProductResponse"},"type":"array"}}},"description":"List of products"}},"tags":["Products"],"description":"Get all products.","operationId":"invoke","summary":"Get all products"}},"/setting":{"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}}],"responses":{"204":{"description":"The setting has been updated."}},"tags":["Settings"],"description":"Update a global setting.","operationId":"updateGlobalSetting","requestBody":{"$ref":"#/components/requestBodies/SettingRequest"},"summary":"Update a global setting"}},"/setting/{key}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The setting key","example":"vat_enabled","in":"path","name":"key","required":true,"schema":{"pattern":"^(receipt_subject|receipt_address|receipt_address_location|vat_standard|location_enabled|receipt_order_recipients|cash_enabled|vat_enabled|use_products|allow_third_party|generic_receipt|employee_can_refund|site_use_generic_receipt|receipt_style|receipt_image|ledger_enabled|split_payments_enabled|stock_enabled|stock_auto_follow|receipt_street_and_house_number|receipt_postal_code|receipt_city|receipt_company_email|receipt_phone_number|receipt_kvk|receipt_btw|receipt_free_text_top|receipt_free_text_bottom|receipt_merchant_name)$","type":"string"}}],"responses":{"204":{"description":"The setting has been deleted successfully."}},"tags":["Settings"],"description":"Delete a global setting and reset the value to default.","operationId":"deleteGlobalSetting","summary":"Delete a global setting"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The setting key","example":"vat_enabled","in":"path","name":"key","required":true,"schema":{"pattern":"^(receipt_subject|receipt_address|receipt_address_location|vat_standard|location_enabled|receipt_order_recipients|cash_enabled|vat_enabled|use_products|allow_third_party|generic_receipt|employee_can_refund|site_use_generic_receipt|receipt_style|receipt_image|ledger_enabled|split_payments_enabled|stock_enabled|stock_auto_follow|receipt_street_and_house_number|receipt_postal_code|receipt_city|receipt_company_email|receipt_phone_number|receipt_kvk|receipt_btw|receipt_free_text_top|receipt_free_text_bottom|receipt_merchant_name)$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}},"description":"A setting, or a default setting if the setting has not been explicitly set yet."}},"tags":["Settings"],"description":"Get a specific global setting.","operationId":"getGlobalSetting","summary":"Get a specific global setting"}},"/settings":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SettingResponse"},"type":"array"}}},"description":"List of settings"}},"tags":["Settings"],"description":"Get all global settings or default settings if not explicitly set.","operationId":"getGlobalSettings","summary":"Get all global settings"}},"/site/{siteId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteResponse"}}},"description":"A site"}},"tags":["Sites"],"description":"Get a specific site","operationId":"getSite","summary":"Get a specific site"},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The site is updated"},"404":{"description":"The site is not found"}},"tags":["Sites"],"description":"Updates a specific site","operationId":"updateSite","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SiteRequest"}}},"required":true},"summary":"Update a site"}},"/site/{siteId}/categories":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/CategoryResponse"},"type":"array"}}},"description":"A list with categories"}},"tags":["Sites"],"description":"Get all categories for a specific site","operationId":"getSiteCategories","summary":"Get all categories for a specific site"}},"/site/{siteId}/ledgers":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LedgerResponse"},"type":"array"}}},"description":"A list of ledgers"}},"tags":["Sites"],"description":"Gets a list of ledgers for a site","operationId":"getLedgers","summary":"Gets ledgers for site"}},"/site/{siteId}/products":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/ProductResponse"},"type":"array"}}},"description":"A list with products"}},"tags":["Sites"],"description":"Get all products for a specific site","operationId":"getSiteProducts","summary":"Get all products for a specific site"}},"/site/{siteId}/setting":{"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":"ABC123","in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}}],"responses":{"204":{"description":"The site settings has been updated successfully"},"403":{"description":"The setting can not be set at site level"}},"tags":["Settings","Sites"],"description":"Update a site setting.","operationId":"updateSiteSetting","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingRequest"}}},"required":true},"summary":"Update a site setting"}},"/site/{siteId}/setting/{key}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":"ABC123","in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The setting key","example":"vat_enabled","in":"path","name":"key","required":true,"schema":{"pattern":"^(receipt_subject|receipt_address|receipt_address_location|vat_standard|location_enabled|receipt_order_recipients|cash_enabled|vat_enabled|use_products|allow_third_party|generic_receipt|employee_can_refund|site_use_generic_receipt|receipt_style|receipt_image|ledger_enabled|split_payments_enabled|stock_enabled|stock_auto_follow|receipt_street_and_house_number|receipt_postal_code|receipt_city|receipt_company_email|receipt_phone_number|receipt_kvk|receipt_btw|receipt_free_text_top|receipt_free_text_bottom|receipt_merchant_name)$","type":"string"}}],"responses":{"200":{"description":"List of products"},"403":{"description":"The setting could not be deleted at site level"}},"tags":["Settings","Sites"],"description":"Delete a site setting and reset the value to global setting value.","operationId":"deleteSiteSetting","summary":"Delete a site setting"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":"ABC123","in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"description":"The setting key","example":"vat_enabled","in":"path","name":"key","required":true,"schema":{"pattern":"^(receipt_subject|receipt_address|receipt_address_location|vat_standard|location_enabled|receipt_order_recipients|cash_enabled|vat_enabled|use_products|allow_third_party|generic_receipt|employee_can_refund|site_use_generic_receipt|receipt_style|receipt_image|ledger_enabled|split_payments_enabled|stock_enabled|stock_auto_follow|receipt_street_and_house_number|receipt_postal_code|receipt_city|receipt_company_email|receipt_phone_number|receipt_kvk|receipt_btw|receipt_free_text_top|receipt_free_text_bottom|receipt_merchant_name)$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingResponse"}}},"description":"A site setting, or the global setting if the setting has not been explicitly set yet."}},"tags":["Sites"],"description":"Get a specific site setting.","operationId":"getSiteSetting","summary":"Get a specific site setting"}},"/site/{siteId}/settings":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SettingResponse"},"type":"array"}}},"description":"List of settings"}},"tags":["Sites"],"description":"Get all settings for a specific site.","operationId":"getSiteSettings","summary":"Get all settings for a specific site"}},"/site/{siteId}/terminals":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The site ID","example":123,"in":"path","name":"siteId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TerminalResponse"},"type":"array"}}},"description":"A list with available settings"}},"tags":["Sites"],"description":"Get all available terminals for a specific site","operationId":"getTerminals_2","summary":"Get all available terminals for site"}},"/sites":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/SiteResponse"},"type":"array"}}},"description":"A list with sites"}},"tags":["Sites"],"description":"Get all available sites for the contract","operationId":"getSites","summary":"Get all available sites"}},"/terminal/{terminalId}":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The terminal ID","example":123,"in":"path","name":"terminalId","required":true,"schema":{"format":"int32","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalResponse"}}},"description":"A list with terminals"},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TerminalResponse"}}},"description":"Terminal could not be found"}},"tags":["Terminals"],"description":"Get a specific terminal for the contract","operationId":"getTerminals_1","summary":"Get a specific terminal"}},"/terminals":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/TerminalResponse"},"type":"array"}}},"description":"A list with terminals"}},"tags":["Terminals"],"description":"Get all available terminals for the contract","operationId":"getTerminals","summary":"Get all available terminals"}},"/user":{"post":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}},"description":"The ID of the new user"}},"tags":["Users"],"description":"Create an user","operationId":"addUser","requestBody":{"$ref":"#/components/requestBodies/UserRequest"},"summary":"Create an user"}},"/user/{userId}":{"delete":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The user ID","example":123,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"The user has been deleted"}},"tags":["Users"],"description":"Delete an existing user","operationId":"deleteUser","summary":"Delete an existing user"},"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The user ID","example":123,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}},{"in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}},"description":"The user"}},"tags":["Users"],"description":"Get a specific user of the contract","operationId":"getUser","summary":"Get a specific user"},"put":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"description":"The user ID","example":123,"in":"path","name":"userId","required":true,"schema":{"format":"int64","type":"integer"}}],"responses":{"204":{"description":"The user has been updated"}},"tags":["Users"],"description":"Update an existing user","operationId":"updateUser","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"required":true},"summary":"Update an existing user"}},"/users":{"get":{"parameters":[{"description":"The contract ID","example":"123456, C123456, U412345","in":"header","name":"Contract","required":false,"schema":{"pattern":"^([A-Z][A-Z0-9]{1,10})|$","type":"string"}},{"example":"application/json","in":"header","name":"Accept","required":true,"schema":{"pattern":"^application\\/json$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array"}}},"description":"A list or users for the contract"}},"tags":["Users"],"description":"Get all users for the contract","operationId":"getUsers","summary":"Get all users"}}},"components":{"requestBodies":{"B2BOrderRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/B2BOrderRequest"}}},"required":true},"CategoryRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CategoryRequest"}}},"required":true},"ProductRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductRequest"}}},"required":true},"SettingRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingRequest"}}},"required":true},"UserRequest":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRequest"}}},"required":true}},"schemas":{"B2BCreateOrderGroupRequest":{"description":"Request object for creating order groups.","properties":{"discount_description":{"description":"Optional discount description.","type":"string"},"discount_percentage":{"description":"Optional discount percentage.","type":"number"},"name":{"description":"The name or reference for the order group.","maxLength":255,"minLength":0,"type":"string"},"order_items":{"description":"The order items. Order items can be added later but at least one should exist when performing payments on the order group.","items":{"$ref":"#/components/schemas/B2BOrderItemRequest"},"type":"array"},"site_id":{"description":"The external ID of the site or commercial unit. When retrieving sites, the `external_id` is the value that should be set here. This property can be set with alias `eternal_id`.","example":"ABC123","maxLength":10,"minLength":4,"type":"string"},"third_party_id":{"description":"The optional (unique) third party ID (such as invoice numbers).","maxLength":255,"minLength":0,"type":"string"},"use_vat":{"description":"Whether to use VAT or not. Mostly, should be kept the same as what is configured for the contract or `true` as default.","type":"boolean"},"user_id":{"description":"Optional user ID. This can be used to show specific order groups only to the user with the ID set with this property.","example":123,"format":"int64","type":"integer"},"visible":{"description":"Whether the order group should be visible (for example in the SmartPin app).","type":"boolean"}},"required":["site_id","use_vat"],"type":"object"},"B2BOrderItemProductOptionRequest":{"description":"A product option for an order item.","properties":{"amount":{"description":"The total amount of the product option. For example: if a product option costs € 0,50 but the `quantity` is `2`, the amount should be set to `1.00`.","example":1,"type":"number"},"amount_original":{"description":"The original total amount of the product option, if an `discount_type` is set for the corresponding order item.","example":0.75,"type":"number"},"constraint":{"description":"The constraint for the product option. When set to `SINGLE` only one product option for the entire order item should be set. Otherwise, multiple are allowed but with different `quantity`'s. This should (but is not required) be the kept as the configuration of the product option.","enum":["SINGLE","MULTIPLE_UNIQUE","MULTIPLE"],"type":"string"},"name":{"description":"The name of the product option. This should (but is not required) be the kept as the configuration of the product option.","example":"Sauce, Extra bag","type":"string"},"price":{"description":"The price of a single item of the product option. For example: if a product option costs € 0,50, the amount should be set to `0.50`.","example":0.5,"type":"number"},"price_original":{"description":"The original price of the product option, if an `discount_type` is set for the corresponding order item.","example":0.25,"type":"number"},"product_option_id":{"description":"The ID of the product option.","example":"558c1b17-73e7-434b-81d5-ae593996a89b","format":"uuid","type":"string"},"quantity":{"description":"The quantity for the product option. Should be positive.","format":"int32","type":"integer"},"required":{"description":"Whether the product option is required for the order item or not. This should (but is not required) be the kept as the configuration of the product option.","type":"boolean"}},"required":["amount","constraint","name","price","product_option_id","quantity","required"],"type":"object"},"B2BOrderItemRequest":{"description":"An item in an order or an order group.","properties":{"amount":{"description":"The price of a single item for this order group.","example":1.23,"type":"number"},"amount_original":{"description":"The original price of a single item for this order group, if an `discount_type` is set for this order item.","example":0.75,"type":"number"},"category_name":{"description":"An optional category name of the product for this order item.","example":"Fruit","type":"string"},"discount_amount":{"description":"The optional discount amount for a single item of this order item. If `discount_type` is set to `PERCENT`, this can be a value between `0` and `100.00`. If the `discount_type` is set to `AMOUNT`, the value can be a value between `0` and the set price of this order item.","type":"number"},"discount_description":{"description":"An optional description for the discount if a `discount_type` is set.","type":"string"},"discount_type":{"description":"The optional discount type for this order item.","enum":["PERCENT","AMOUNT"],"type":"string"},"favorite_id":{"description":"The optional ID of a known SmartPin product that is set for this order item.","example":123,"format":"int64","type":"integer"},"name":{"description":"The name of the order item.","example":"Apple","type":"string"},"product_options":{"description":"The product options, if any, for this order item.","items":{"$ref":"#/components/schemas/B2BOrderItemProductOptionRequest"},"type":"array"},"quantity":{"description":"The quantity of the articles in this order item. Must be a positive amount. If an order item is created for a product that uses units, this should always be set to `1`. A product uses units when `unit`, `unit_base`, `unit_price_base` and `unit_amount` is set.","example":10,"type":"number"},"third_party_id":{"description":"An optional third party ID for this order item.","type":"string"},"unit":{"description":"The unit of the order item, if a product which uses units is set. A product uses units, if it is sold per unit. For example: a product is sold per 100 g. If this is set `quantity` should be set to `1`.","example":"g, kg, cm","type":"string"},"unit_amount":{"description":"The unit amount for a product, if a product which uses units is set. For example: if 250 g of Apples is sold, the `unit_amount` should be set to `250.0`. If this is set `quantity` should be set to `1`.","example":250,"type":"number"},"unit_base":{"description":"The unit quantity of the unit, if a product which uses units is set. For example: if a product is sold per 100 g, the `unit_base` would be set to `100.0`. If this is set `quantity` should be set to `1`.","type":"number"},"unit_price_base":{"description":"The price per base amount set in `unit_base`, if a product which uses units is set. For example: if an item is sold for € 15.00 per 100 g, the `unit_price_base` is set to `15.00`. If this is set `quantity` should be set to `1`.","example":15,"type":"number"},"vat_type":{"description":"The VAT type for this order item.","enum":["REGULAR","LOW","ZERO","LOW_6"],"type":"string"}},"required":["amount","vat_type"],"type":"object"},"B2BOrderRequest":{"properties":{"aid":{"type":"string"},"amount":{"type":"number"},"auth_code":{"type":"string"},"external_id":{"type":"string"},"online":{"format":"int32","type":"integer"},"pan":{"type":"string"},"payment_method":{"pattern":"^(.)*$","type":"string"},"phone_date":{"format":"date-time","type":"string"},"reference":{"type":"string"},"response_code":{"format":"int64","type":"integer"},"site_id":{"pattern":"^([A-Z0-9_]{1,10})|$","type":"string"},"state":{"enum":["APPROVED","DECLINED","PENDING"],"maxLength":255,"minLength":0,"type":"string"},"status":{"format":"int32","type":"integer"},"terminal_date":{"format":"date-time","type":"string"},"terminal_id":{"pattern":"^([A-Z0-9]{1,10})|$","type":"string"},"third_party_id":{"type":"string"},"transaction_id":{"type":"string"},"type":{"enum":["PIN","CASH","IDEAL","PAYMENTREQ"],"pattern":"^(PIN|CASH|IDEAL|PAYMENTREQ)$","type":"string"}},"required":["amount","status","third_party_id","type"],"type":"object"},"B2BUpdateOrderGroupRequest":{"properties":{"discount_description":{"description":"Optional discount description.","type":"string"},"discount_percentage":{"description":"Optional discount percentage.","type":"number"},"name":{"description":"The name of reference for the order group.","maxLength":255,"minLength":0,"type":"string"},"order_items":{"description":"The order items. Order items can be added later but at least one should exist when performing payments on the order group.","items":{"$ref":"#/components/schemas/B2BOrderItemRequest"},"type":"array"},"third_party_id":{"description":"The optional (unique) third party ID such as invoice numbers.","maxLength":255,"minLength":0,"type":"string"},"user_id":{"description":"Optional user ID. This can be used to show specific order groups only to the user with the ID set with this property.","example":123,"format":"int64","type":"integer"},"visible":{"description":"Whether the order group should be visible (for example in the SmartPin app).","type":"boolean"}},"type":"object"},"CategoryRequest":{"properties":{"disabled_sites":{"items":{"format":"int32","type":"integer"},"type":"array"},"name":{"type":"string"}},"required":["name"],"type":"object"},"CategoryResponse":{"properties":{"disabled_sites":{"items":{"format":"int32","type":"integer"},"type":"array"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"}},"required":["id"],"type":"object"},"CheckThirdPartyIdRequest":{"properties":{"third_party_id":{"description":"The third party ID","maxLength":255,"minLength":1,"type":"string"}},"required":["third_party_id"],"type":"object"},"CheckThirdPartyIdResponse":{"properties":{"available":{"description":"Whether the third party is still available, or already used.","type":"boolean"}},"required":["available"],"type":"object"},"CreateCategoryResponse":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"},"CreateOrderGroupResponse":{"properties":{"id":{"description":"The ID of the created order group.","format":"int64","type":"integer"}},"type":"object"},"CreateOrderResponse":{"properties":{"external_id":{"type":"string"},"order_id":{"format":"int64","type":"integer"}},"required":["external_id","order_id"],"type":"object"},"CreateProductResponse":{"properties":{"id":{"format":"int32","type":"integer"}},"type":"object"},"CreateUserResponse":{"properties":{"id":{"format":"int64","type":"integer"}},"type":"object"},"DefaultSettingResponse":{"properties":{"default_value":{"type":"string"},"is_site_setting":{"type":"boolean"},"key":{"type":"string"},"possible_values":{"items":{"type":"string"},"type":"array"},"type":{"type":"string"}},"type":"object"},"ImageResponse":{"properties":{"id":{"format":"int32","type":"integer"},"image":{"type":"string"},"provider":{"type":"string"},"thumbnail":{"type":"string"},"type":{"type":"string"}},"type":"object"},"LedgerPeriodEventResponse":{"properties":{"action":{"type":"string"},"event_date":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"order_id":{"format":"int64","type":"integer"},"remark":{"type":"string"},"username":{"type":"string"},"value":{"format":"int32","type":"integer"}},"required":["value"],"type":"object"},"LedgerPeriodResponse":{"properties":{"balance":{"format":"int32","type":"integer"},"cash_difference":{"format":"int32","type":"integer"},"end_date":{"format":"date-time","type":"string"},"id":{"format":"int32","type":"integer"},"open":{"type":"boolean"},"skimming":{"format":"int32","type":"integer"},"start_balance":{"format":"int32","type":"integer"},"start_date":{"format":"date-time","type":"string"},"transaction_amount":{"type":"number"},"transaction_count":{"format":"int32","type":"integer"}},"required":["open","transaction_amount","transaction_count"],"type":"object"},"LedgerResponse":{"properties":{"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"site_id":{"format":"int32","type":"integer"}},"type":"object"},"LocationResponse":{"properties":{"latitude":{"format":"double","type":"number"},"longitude":{"format":"double","type":"number"}},"type":"object"},"OAuth2AccessTokenResponse":{"properties":{"access_token":{"type":"string"},"scope":{"type":"string"},"token_type":{"type":"string"}},"type":"object"},"OrderGroupResponse":{"description":"An order group object.","properties":{"can_close":{"description":"Whether the order group can be closed manually, without having to handle the open amount.","type":"boolean"},"can_delete":{"description":"Whether the order group can be deleted.","type":"boolean"},"closed":{"description":"Whether the order group has been completely been paid for and is closed. A closed order group cannot be modified anymore.","type":"boolean"},"closed_amount":{"description":"Total amount already paid for.","type":"number"},"created_date_time":{"description":"The created date and time of this order group.","format":"date-time","type":"string"},"discount_amount":{"description":"Total discount amount.","type":"number"},"discount_description":{"description":"The optional discount description of this order group.","type":"string"},"discount_percentage":{"description":"The optionsl discount percentage of this order group.","type":"number"},"external_id":{"description":"The external ID of the site or commercial unit this order group is assigned to. This is the same as `site_external_id`.","type":"string"},"id":{"description":"The ID of the order group.","format":"int64","type":"integer"},"modified_date_time":{"description":"The modified date and time of this order group.","format":"date-time","type":"string"},"name":{"description":"The name or reference for the order group.","type":"string"},"open_amount":{"description":"Total amount for which still has to be paid for.","type":"number"},"order_items":{"description":"The order items for this order group.","items":{"$ref":"#/components/schemas/OrderItemResponse"},"type":"array"},"orders":{"description":"The orders that have been started for this order group. The orders may or may not bee completed or failed. An order group is closed when all orders for the total amount of this order group have been successful.","items":{"$ref":"#/components/schemas/OrderResponse"},"type":"array"},"pending":{"description":"Whether the order group has been partially been paid for but is not yet closed. A pending order group cannot be modified anymore.","type":"boolean"},"show_vat":{"description":"Whether the order group and the potential orders use VAT or not.","type":"boolean"},"site_external_id":{"description":"The external ID of the site or commercial unit to which this order group is assigned. This is the same as `site_external_id`","type":"string"},"split":{"description":"Whether the order group has been split into multiple payments.","type":"boolean"},"third_party_id":{"description":"The optional (unique) third party ID (such as invoice numbers).","type":"string"},"total_amount":{"description":"The total amount for this order group.","type":"number"},"total_amount_low_vat":{"description":"The total amount of low VAT.","type":"number"},"total_amount_low_vat_base":{"description":"The total amount over which low VAT was calculated.","type":"number"},"total_amount_regular_vat":{"description":"The total amount of high or regular VAT.","type":"number"},"total_amount_regular_vat_base":{"description":"The total amount over which high or regular VAT was calculated.","type":"number"},"total_amount_vat":{"description":"The total VAT amount for this order group.","type":"number"},"total_amount_vat_base":{"description":"The total amount over which VAT was calculated (total amount without VAT).","type":"number"},"total_amount_without_discount":{"description":"The total amount excluding the discount for this order group.","type":"number"},"total_amount_zero_vat":{"description":"The total amount of zero VAT (which is always 0.00).","type":"number"},"total_amount_zero_vat_base":{"description":"The total amount over which zero VAT was calculated.","type":"number"},"user_id":{"description":"The user ID which is assigned or who created (in the SmartPin app) the order group.","format":"int64","type":"integer"}},"required":["can_close","can_delete","closed","closed_amount","discount_amount","open_amount","order_items","orders","pending","show_vat","split","total_amount","total_amount_low_vat","total_amount_low_vat_base","total_amount_regular_vat","total_amount_regular_vat_base","total_amount_vat","total_amount_vat_base","total_amount_without_discount","total_amount_zero_vat","total_amount_zero_vat_base"],"type":"object"},"OrderItemProductOptionsResponse":{"properties":{"amount":{"type":"number"},"amount_original":{"type":"number"},"constraint":{"enum":["SINGLE","MULTIPLE_UNIQUE","MULTIPLE"],"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"price_original":{"type":"number"},"product_option_id":{"format":"uuid","type":"string"},"quantity":{"format":"int32","type":"integer"},"required":{"type":"boolean"},"sequence":{"format":"int32","type":"integer"}},"required":["product_option_id"],"type":"object"},"OrderItemResponse":{"properties":{"amount":{"description":"The total amount for all items (price * quantity), including any item discount.","type":"number"},"amount_original":{"description":"The total amount for all items (price_original * quantity), excluding any item discount.","type":"number"},"category_name":{"description":"Optional name of the category when using a product in a category.","type":"string"},"name":{"description":"The name of the order item. It can be either a product name or a self assigned name.","type":"string"},"price":{"description":"The price for a single item, including any item discount.","type":"number"},"price_original":{"description":"The price for a single item, excluding any item discount.","type":"number"},"product_options":{"items":{"$ref":"#/components/schemas/OrderItemProductOptionsResponse"},"type":"array"},"quantity":{"description":"The quantity of the items.","type":"number"},"unit":{"description":"The unit of the order item, if a product which uses units is set. A product uses units, if it is sold per unit. For example: a product is sold per 100 g. ","type":"string"},"unit_amount":{"type":"number"},"unit_base":{"description":"The unit quantity of the unit, if a product which uses units is set. For example: if a product is sold per 100 g, the `unit_base` would be set to `100.0`. ","type":"number"},"unit_price_base":{"type":"number"},"vat_type":{"description":"The VAT type","enum":["REGULAR","LOW","ZERO","LOW_6"],"type":"string"}},"required":["quantity"],"type":"object"},"OrderResponse":{"properties":{"aid":{"type":"string"},"amount":{"type":"number"},"auth_code":{"type":"string"},"authorization_code":{"type":"string"},"card_type":{"type":"string"},"change_amount":{"type":"number"},"date_time":{"format":"date-time","type":"string"},"discount_description":{"type":"string"},"discount_percent":{"type":"number"},"error_code":{"format":"int64","type":"integer"},"external_id":{"type":"string"},"id":{"format":"int64","type":"integer"},"ledger_id":{"format":"int32","type":"integer"},"location":{"$ref":"#/components/schemas/LocationResponse"},"order_items":{"items":{"$ref":"#/components/schemas/OrderItemResponse"},"type":"array"},"paid_amount":{"type":"number"},"receipt_name":{"type":"string"},"reference":{"type":"string"},"site_external_id":{"type":"string"},"site_id":{"format":"int32","type":"integer"},"state":{"enum":["APPROVED","DECLINED","PENDING"],"type":"string"},"status":{"format":"int32","type":"integer"},"terminal_external_id":{"type":"string"},"terminal_id":{"format":"int32","type":"integer"},"third_party_reference":{"type":"string"},"transaction_id":{"type":"string"},"truncated_pan":{"type":"string"},"type":{"enum":["PIN","CASH","IDEAL","PAYMENTREQ"],"type":"string"},"user_id":{"format":"int64","type":"integer"},"vat_enabled":{"type":"boolean"},"vat_high_amount":{"type":"number"},"vat_high_base_amount":{"type":"number"},"vat_low_amount":{"type":"number"},"vat_low_base_amount":{"type":"number"},"vat_zero_amount":{"type":"number"},"vat_zero_base_amount":{"type":"number"},"verified":{"type":"boolean"}},"required":["id","verified"],"type":"object"},"ProductRequest":{"properties":{"category_id":{"format":"int32","type":"integer"},"ean":{"type":"string"},"name":{"type":"string"},"price":{"type":"number"},"vat_type":{"enum":["REGULAR","LOW","ZERO","LOW_6"],"type":"string"}},"required":["name","price","vat_type"],"type":"object"},"ProductResponse":{"properties":{"category_id":{"format":"int32","type":"integer"},"ean":{"type":"string"},"id":{"format":"int32","type":"integer"},"image":{"$ref":"#/components/schemas/ImageResponse"},"name":{"type":"string"},"price":{"type":"number"},"vat_type":{"type":"string"}},"type":"object"},"SettingRequest":{"properties":{"key":{"pattern":"^(receipt_subject|receipt_address|receipt_address_location|vat_standard|location_enabled|receipt_order_recipients|cash_enabled|vat_enabled|use_products|allow_third_party|generic_receipt|employee_can_refund|site_use_generic_receipt|receipt_style|receipt_image|ledger_enabled|split_payments_enabled|stock_enabled|stock_auto_follow|receipt_street_and_house_number|receipt_postal_code|receipt_city|receipt_company_email|receipt_phone_number|receipt_kvk|receipt_btw|receipt_free_text_top|receipt_free_text_bottom|receipt_merchant_name)$","type":"string"},"value":{"type":"string"}},"required":["key"],"type":"object"},"SettingResponse":{"properties":{"key":{"type":"string"},"site_external_id":{"type":"string"},"site_id":{"format":"int32","type":"integer"},"type":{"type":"string"},"value":{"type":"string"}},"type":"object"},"SiteRequest":{"properties":{"name":{"type":"string"}},"required":["name"],"type":"object"},"SiteResponse":{"properties":{"external_id":{"type":"string"},"id":{"format":"int32","type":"integer"},"name":{"type":"string"},"terminals":{"items":{"$ref":"#/components/schemas/TerminalResponse"},"type":"array"}},"type":"object"},"TerminalResponse":{"properties":{"external_id":{"type":"string"},"id":{"format":"int32","type":"integer"},"site_id":{"format":"int32","type":"integer"},"type":{"type":"string"}},"type":"object"},"TokenRequest":{"properties":{"access_token_validity":{"format":"double","type":"number"},"grant_type":{"pattern":"^client_credentials$","type":"string"},"otp":{"pattern":"^[a-zA-Z0-9]{1,10}$","type":"string"}},"required":["grant_type","otp"],"type":"object"},"UserRequest":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"receipt_name":{"type":"string"},"role":{"enum":["none","contract_owner","administrator","user_plus","user_basic","finance","user_register"],"type":"string"},"sites":{"items":{"format":"int32","type":"integer"},"type":"array"}},"required":["email","role"],"type":"object"},"UserResponse":{"properties":{"email":{"type":"string"},"first_name":{"type":"string"},"id":{"format":"int64","type":"integer"},"last_name":{"type":"string"},"receipt_name":{"type":"string"},"role":{"enum":["none","contract_owner","administrator","user_plus","user_basic","finance","user_register"],"type":"string"},"sites":{"items":{"format":"int32","type":"integer"},"type":"array"}},"type":"object"},"ValidateRequest":{"properties":{"sdk_platform":{"pattern":"^(iOS|Android|)$","type":"string"},"sdk_version":{"type":"string"}},"required":["sdk_platform","sdk_version"],"type":"object"}},"securitySchemes":{"clientId":{"description":"ClientId as provided by the Rabobank developer portal.","in":"header","name":"X-IBM-Client-Id","type":"apiKey"}}},"security":[{"clientId":[]}],"x-readme":{"explorer-enabled":false,"proxy-enabled":false}}