id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
a617101b-0190-4456-a932-cee1c3bc5471/86c8ada0-a23a-4699-adc3-f1db201dcef2/2/0
Hello OpenAPI
Hi
null
getStores
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/86c8ada0-a23a-4699-adc3-f1db201dcef2/2/1
Hello OpenAPI
Hi
null
getStores
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a0058c5c-5fc9-4889-b980-ff10adc52a57/4/0
Hello OpenAPI
Hi
null
updateStore
Update the Store info. This updates only the passed parameters, all the parameters not set will be left untouched.
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a0058c5c-5fc9-4889-b980-ff10adc52a57/4/1
Hello OpenAPI
Hi
null
updateStore
Update the Store info. This updates only the passed parameters, all the parameters not set will be left untouched.
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4b601140-e2cb-41cc-a53f-245b1608b4c9/2/0
Hello OpenAPI
Hi
null
delStore
When a Store is deleted it's not recoverable anymore
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4b601140-e2cb-41cc-a53f-245b1608b4c9/2/1
Hello OpenAPI
Hi
null
delStore
When a Store is deleted it's not recoverable anymore
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/80e960d8-59ab-4085-b96d-6c6c049b0502/0/0
Hello OpenAPI
Hi
null
getStoreInfoPages
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/80e960d8-59ab-4085-b96d-6c6c049b0502/0/1
Hello OpenAPI
Hi
null
getStoreInfoPages
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4ff3ab39-dc0a-4e65-9796-7c99afbdbf82/2/0
Hello OpenAPI
Hi
null
/Store/
Creates a Store associated to the account specified by the 'account_id' parameter. If you don't have the Account you need to call before the 'create merchant' API
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4ff3ab39-dc0a-4e65-9796-7c99afbdbf82/2/1
Hello OpenAPI
Hi
null
/Store/
Creates a Store associated to the account specified by the 'account_id' parameter. If you don't have the Account you need to call before the 'create merchant' API
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/883726eb-0f42-423b-a535-cedeb9567856/2/0
Hello OpenAPI
Hi
null
getCustomerLoyaltyPoints
Get loyalty points of a customer by the store_id and the account_id
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/883726eb-0f42-423b-a535-cedeb9567856/2/1
Hello OpenAPI
Hi
null
getCustomerLoyaltyPoints
Get loyalty points of a customer by the store_id and the account_id
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/759d6647-906d-4151-b122-61396f9c791d/0/0
Hello OpenAPI
Hi
null
deleteLoyaltyReward
Delete a loyalty reward
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/759d6647-906d-4151-b122-61396f9c791d/0/1
Hello OpenAPI
Hi
null
deleteLoyaltyReward
Delete a loyalty reward
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/6588ec7e-d083-4ad0-a78f-c684f9c4a0db/4/0
Hello OpenAPI
Hi
null
getStoreOrders
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/6588ec7e-d083-4ad0-a78f-c684f9c4a0db/4/1
Hello OpenAPI
Hi
null
getStoreOrders
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a5edbf61-70ab-467c-a633-7f05191b6216/4/0
Hello OpenAPI
Hi
null
getLoyaltyReward
Get loyalty rewards list
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a5edbf61-70ab-467c-a633-7f05191b6216/4/1
Hello OpenAPI
Hi
null
getLoyaltyReward
Get loyalty rewards list
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/b54e8fa5-b754-4900-a3f4-e9ee8a38e0a2/4/0
Hello OpenAPI
Hi
null
sendStorePromotionTest
Send the Promotion to a test email
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/b54e8fa5-b754-4900-a3f4-e9ee8a38e0a2/4/1
Hello OpenAPI
Hi
null
sendStorePromotionTest
Send the Promotion to a test email
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/985a71e6-88a2-4ffd-8a13-5d4bbb16ee60/5/0
Hello OpenAPI
Hi
null
sendLoyaltyCards
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/985a71e6-88a2-4ffd-8a13-5d4bbb16ee60/5/1
Hello OpenAPI
Hi
null
sendLoyaltyCards
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/6fd85ce3-2335-4d7e-9a68-a51a95e9215b/2/0
Hello OpenAPI
Hi
null
sendStorePromotion
Send the Promotion via the specified channels
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/6fd85ce3-2335-4d7e-9a68-a51a95e9215b/2/1
Hello OpenAPI
Hi
null
sendStorePromotion
Send the Promotion via the specified channels
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/ffcc0057-d400-4d15-a11a-03852df297d3/1/0
Hello OpenAPI
Hi
null
getMoreMerchant
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/ffcc0057-d400-4d15-a11a-03852df297d3/1/1
Hello OpenAPI
Hi
null
getMoreMerchant
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/f6d32c8b-256e-497f-a9b0-77e9012c2d3e/4/0
Hello OpenAPI
Hi
null
setStoreDiscount
Create a new discount
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/f6d32c8b-256e-497f-a9b0-77e9012c2d3e/4/1
Hello OpenAPI
Hi
null
setStoreDiscount
Create a new discount
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/54460762-3cb0-47c8-9b5f-2cbe9c377488/1/0
Hello OpenAPI
Hi
null
getCouponStatus
Check a coupons status by the store_id and the coupon code
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/54460762-3cb0-47c8-9b5f-2cbe9c377488/1/1
Hello OpenAPI
Hi
null
getCouponStatus
Check a coupons status by the store_id and the coupon code
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/d2928665-6e42-4ae1-b748-fa3d87b433c2/2/0
Hello OpenAPI
Hi
null
getStoreProducts
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/d2928665-6e42-4ae1-b748-fa3d87b433c2/2/1
Hello OpenAPI
Hi
null
getStoreProducts
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/ecca62a2-668b-44b6-92d3-a9e59631d0e4/1/0
Hello OpenAPI
Hi
null
getStore
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/ecca62a2-668b-44b6-92d3-a9e59631d0e4/1/1
Hello OpenAPI
Hi
null
getStore
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/24bfd4d2-263c-4dcb-8573-7b72b31e2ebb/1/0
Hello OpenAPI
Hi
null
getCouponsStats
Get the stats about coupons use for a time range
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/24bfd4d2-263c-4dcb-8573-7b72b31e2ebb/1/1
Hello OpenAPI
Hi
null
getCouponsStats
Get the stats about coupons use for a time range
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/e263f8ba-cda1-4e38-aa53-a6c0520176cc/3/0
Hello OpenAPI
Hi
null
setAutoPilot
Enable or disable the AutoPilot for the specified Store, if you do not send the Request body the Autopilot will be set with default configuration
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/e263f8ba-cda1-4e38-aa53-a6c0520176cc/3/1
Hello OpenAPI
Hi
null
setAutoPilot
Enable or disable the AutoPilot for the specified Store, if you do not send the Request body the Autopilot will be set with default configuration
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/71393da3-6c7a-48d7-adaf-cb44ff49fc99/4/0
Hello OpenAPI
Hi
null
sendMarketingKit
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/71393da3-6c7a-48d7-adaf-cb44ff49fc99/4/1
Hello OpenAPI
Hi
null
sendMarketingKit
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/8e6e4cfd-d25e-4586-be78-e5ceea2487a8/3/0
Hello OpenAPI
Hi
null
updateStoreExtended
Update the Store info. This updates only the passed parameters, all the parameters not set will be left untouched.
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/8e6e4cfd-d25e-4586-be78-e5ceea2487a8/3/1
Hello OpenAPI
Hi
null
updateStoreExtended
Update the Store info. This updates only the passed parameters, all the parameters not set will be left untouched.
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/58609a22-9db6-44ca-9fa7-34206089185f/3/0
Hello OpenAPI
Hi
null
getReviews
Get the Reviews
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/58609a22-9db6-44ca-9fa7-34206089185f/3/1
Hello OpenAPI
Hi
null
getReviews
Get the Reviews
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/fa7d77dd-33da-4d0d-8d22-ff68dca17d4c/0/0
Hello OpenAPI
Hi
null
updateCustomer
Update a customer of a store. It searches for existing customer by account_id, if account_id is not set it tries to find an already existing customer via by phone and/or email (because they must be unique within the store).
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/fa7d77dd-33da-4d0d-8d22-ff68dca17d4c/0/1
Hello OpenAPI
Hi
null
updateCustomer
Update a customer of a store. It searches for existing customer by account_id, if account_id is not set it tries to find an already existing customer via by phone and/or email (because they must be unique within the store).
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/0d7fc125-1093-450a-91eb-0f2b019abc22/4/0
Hello OpenAPI
Hi
null
getPlanById
Get plan info by the plan ID
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/0d7fc125-1093-450a-91eb-0f2b019abc22/4/1
Hello OpenAPI
Hi
null
getPlanById
Get plan info by the plan ID
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/597c7957-9240-4b97-9bba-f30f6bb09a7b/4/0
Hello OpenAPI
Hi
null
getPlans
Get plans info
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/597c7957-9240-4b97-9bba-f30f6bb09a7b/4/1
Hello OpenAPI
Hi
null
getPlans
Get plans info
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/3a1c89fd-ec84-43cc-bd2a-8b43b32cdb26/4/0
Hello OpenAPI
Hi
null
setPlan
Applies the specified plan to the store and set the expiring date to 'unlimited'. To set a different expiring date use the query param 'new_expiring_date'
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/3a1c89fd-ec84-43cc-bd2a-8b43b32cdb26/4/1
Hello OpenAPI
Hi
null
setPlan
Applies the specified plan to the store and set the expiring date to 'unlimited'. To set a different expiring date use the query param 'new_expiring_date'
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/9b067d80-c16f-46b4-8543-866a47afb7c4/1/0
Hello OpenAPI
Hi
null
getStoreOffers
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/9b067d80-c16f-46b4-8543-866a47afb7c4/1/1
Hello OpenAPI
Hi
null
getStoreOffers
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/35ecfb67-b0f3-4ad0-87c4-386a50bca683/5/0
Hello OpenAPI
Hi
null
delCustomer
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/35ecfb67-b0f3-4ad0-87c4-386a50bca683/5/1
Hello OpenAPI
Hi
null
delCustomer
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/f83ad72a-c053-4c0b-952e-f739818ef243/4/0
Hello OpenAPI
Hi
null
addCustomerLoyaltyPoints
Update loyalty points for a customer by the store_id and the customer_id
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/f83ad72a-c053-4c0b-952e-f739818ef243/4/1
Hello OpenAPI
Hi
null
addCustomerLoyaltyPoints
Update loyalty points for a customer by the store_id and the customer_id
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/c7094926-b4f0-4a3b-8731-9d995a5566ff/3/0
Hello OpenAPI
Hi
null
updateStoreInfoPages
Update the Store info. It updates only the passed parameters, all the parameters not set will be left untouched.
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/c7094926-b4f0-4a3b-8731-9d995a5566ff/3/1
Hello OpenAPI
Hi
null
updateStoreInfoPages
Update the Store info. It updates only the passed parameters, all the parameters not set will be left untouched.
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/39dc20e4-e2f7-4777-8653-39a0164ea5bc/1/0
Hello OpenAPI
Hi
null
delMerchant
When a merchant is deleted all his associated stores are deleted and it's not recoverable anymore
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/39dc20e4-e2f7-4777-8653-39a0164ea5bc/1/1
Hello OpenAPI
Hi
null
delMerchant
When a merchant is deleted all his associated stores are deleted and it's not recoverable anymore
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a3f4ff7a-b9d1-4a3e-af9b-6e790757b945/0/0
Hello OpenAPI
Hi
null
setLoyaltyReward
Create or update the loyalty reward
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/a3f4ff7a-b9d1-4a3e-af9b-6e790757b945/0/1
Hello OpenAPI
Hi
null
setLoyaltyReward
Create or update the loyalty reward
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/e1066e52-1c09-477e-bc99-b8ebfb2af71c/4/0
Hello OpenAPI
Hi
null
getFeedback
Get the Feedback
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/e1066e52-1c09-477e-bc99-b8ebfb2af71c/4/1
Hello OpenAPI
Hi
null
getFeedback
Get the Feedback
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/31ed6e5c-5d80-4a53-9fd6-9c972a941d61/3/0
Hello OpenAPI
Hi
null
setStorePromotion
Create a new Promotion
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/31ed6e5c-5d80-4a53-9fd6-9c972a941d61/3/1
Hello OpenAPI
Hi
null
setStorePromotion
Create a new Promotion
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4f384ef6-3291-4ea8-be84-976529dacb1a/5/0
Hello OpenAPI
Hi
null
/Merchant/Stores/{account_id}/
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/4f384ef6-3291-4ea8-be84-976529dacb1a/5/1
Hello OpenAPI
Hi
null
/Merchant/Stores/{account_id}/
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/fdc1b240-cb8b-4f03-8299-7e62b74c8067/2/0
Hello OpenAPI
Hi
null
getAutoPilot
Check if the AutoPilot is enabled for the specified Store
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/fdc1b240-cb8b-4f03-8299-7e62b74c8067/2/1
Hello OpenAPI
Hi
null
getAutoPilot
Check if the AutoPilot is enabled for the specified Store
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/babe0ff2-3738-4845-9fd0-15a3a555a508/2/0
Hello OpenAPI
Hi
null
setCouponStatus
Set a coupon status by the store_id and the coupon_code
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/babe0ff2-3738-4845-9fd0-15a3a555a508/2/1
Hello OpenAPI
Hi
null
setCouponStatus
Set a coupon status by the store_id and the coupon_code
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/355bd8fd-db3f-4435-ad4b-d943833113fc/3/0
Hello OpenAPI
Hi
null
setStoreMessage
Create a new message
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/355bd8fd-db3f-4435-ad4b-d943833113fc/3/1
Hello OpenAPI
Hi
null
setStoreMessage
Create a new message
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/2fe78885-f759-47d9-9302-160a698c8db8/3/0
Hello OpenAPI
Hi
null
getStoreStats
Get the stats about the store
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/2fe78885-f759-47d9-9302-160a698c8db8/3/1
Hello OpenAPI
Hi
null
getStoreStats
Get the stats about the store
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/1205cf18-4dc0-48d6-805a-3775666f5afd/4/0
Hello OpenAPI
Hi
null
setCustomer
Insert a new customer in a store. It looks for existing customer by phone and/or email and if it exists it will update it.
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/1205cf18-4dc0-48d6-805a-3775666f5afd/4/1
Hello OpenAPI
Hi
null
setCustomer
Insert a new customer in a store. It looks for existing customer by phone and/or email and if it exists it will update it.
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/bd60ff5f-71e1-47e8-afda-0bbc47318c8a/2/0
Hello OpenAPI
Hi
null
/Merchant/Login/{id}/
hi
200
Example_1
{"account_id": "", "array": [{"login_url": "", "store_id": "", "store_name_url": ""}]}
{"properties": {"account_id": {"type": "string"}, "array": {"items": {"properties": {"login_url": {"type": "string"}, "store_id": {"type": "string"}, "store_name_url": {"type": "string"}}, "type": "object"}, "type": "array"}}, "type": "object"}
a617101b-0190-4456-a932-cee1c3bc5471/bd60ff5f-71e1-47e8-afda-0bbc47318c8a/4/0
Hello OpenAPI
Hi
null
/Merchant/Login/{id}/
hi
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/bd60ff5f-71e1-47e8-afda-0bbc47318c8a/4/1
Hello OpenAPI
Hi
null
/Merchant/Login/{id}/
hi
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/7a3e356d-b982-4a48-885f-6d38e01adf20/0/0
Hello OpenAPI
Hi
null
setMerchant
Call this API to obtain the account_id that you need for the create store APIitem oneitem twosublistsublist
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/7a3e356d-b982-4a48-885f-6d38e01adf20/0/1
Hello OpenAPI
Hi
null
setMerchant
Call this API to obtain the account_id that you need for the create store APIitem oneitem twosublistsublist
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/7a3e356d-b982-4a48-885f-6d38e01adf20/1/0
Hello OpenAPI
Hi
null
setMerchant
Call this API to obtain the account_id that you need for the create store APIitem oneitem twosublistsublist
201
Example_1
{"address": "2590 Wallace St", "business_name": "My new Bar", "city": "Oakland", "country": "United States", "email": "[email protected]", "external_account_id": "of83-ja7dj-49kd", "first_name": "Bill", "last_name": "White", "partner_code": "partner-ref", "password": "123456", "state": "CA", "username": "[email protected]", "vat_number": "1918171615", "zip": "94606"}
{"example": {"address": "2590 Wallace St", "business_name": "My new Bar", "city": "Oakland", "country": "United States", "email": "[email protected]", "external_account_id": "of83-ja7dj-49kd", "first_name": "Bill", "last_name": "White", "partner_code": "partner-ref", "password": 123456, "state": "CA", "username": "[email protected]", "vat_number": 1918171615, "zip": 94606}, "properties": {"account_id": {"description": "the id of the merchant account, not used for creation", "type": "integer"}, "address": {"description": "address of the merchant", "type": "string"}, "business_name": {"description": "business name", "type": "string"}, "city": {"description": "city of the merchant", "type": "string"}, "country": {"description": "country of the merchant", "type": "string"}, "email": {"description": "email of the merchant", "type": "string"}, "external_account_id": {"description": "the Movylo partner merchant account Id", "type": "string"}, "first_name": {"description": "first name of the merchant", "type": "string"}, "fiscal_code": {"description": "fiscal code of the merchant", "type": "string"}, "last_name": {"description": "last name of the merchant", "type": "string"}, "partner_code": {"description": "the Movylo partner code, if provided you must use it when you create the merchant account", "type": "string"}, "password": {"description": "password of the merchant, if not provided at creation will be randomly generated", "type": "string"}, "phone": {"description": "phone of the merchant", "type": "string"}, "state": {"description": "state of the merchant", "type": "string"}, "username": {"description": "username of the merchant, if not provided at creation the required email field is also used as username", "type": "string"}, "vat_number": {"description": "vat number of the business", "type": "string"}, "zip": {"description": "zip code of the merchant", "type": "string"}}, "required": ["email"], "type": "object"}
a617101b-0190-4456-a932-cee1c3bc5471/b439d97d-de31-42e3-9555-76bdbca47173/1/0
Hello OpenAPI
Hi
null
/Authentication/
description
200
Example_1
{"access_token": "", "expires_in": "", "token_type": ""}
{"properties": {"access_token": {"description": "The Bearer access token", "type": "string"}, "expires_in": {"description": "The token duration, in seconds", "type": "string"}, "token_type": {"description": "The token type", "type": "string"}}, "type": "object"}
a617101b-0190-4456-a932-cee1c3bc5471/b439d97d-de31-42e3-9555-76bdbca47173/2/0
Hello OpenAPI
Hi
null
/Authentication/
description
400
Another bad value
{"code": 599, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
a617101b-0190-4456-a932-cee1c3bc5471/b439d97d-de31-42e3-9555-76bdbca47173/2/1
Hello OpenAPI
Hi
null
/Authentication/
description
400
This is an invalid value
{"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}
{"not": {"description": "409 Resource Already Exists"}, "oneOf": [{"example": {"error": {"code": 501, "message": "Bad request. Invalid input parameters. Missing required parameters. Parameter 'account_id' is required."}}, "properties": {"error": {"properties": {"code": {"deprecated": false, "format": "int32", "maxLength": 14, "minLength": 3, "pattern": "[a-z0-9]{8,64}", "type": "integer"}, "message": {"type": "string"}}, "type": "object"}}, "type": "object"}]}
f952acfb-0a51-45fb-a685-62230bff8a2d/9cb02658-1d4d-4d79-9ee4-298a085e58e4/0/0
Smart OCR
Extract information from business documents like invoices
null
Extract Invoice Information
Extract products, customer, and price information from PDF or image
200
Response
{"parsed": {"document_type": "invoice", "amount": 2213750, "amount_change": 0, "amount_shipping": 0, "amount_tip": 0, "vatamount": 0, "amountexvat": 2213750, "currency": "USD", "date": "2022-02-08T00:00:00", "purchasedate": "2022-02-08", "purchasetime": "00:00:00", "date_of_arrival": "", "date_of_departure": "", "vatitems": [], "vat_context": "", "lines": [{"description": "", "lineitems": [{"title": "[FURN_8999] Three-Seat Sofa 5.00 Units 1,500.00 15.00% 7,500.00\nThree Seater Sofa with Lounger in Steel Grey Colour", "description": "", "amount": 750000, "amount_each": 150000, "amount_ex_vat": 750000, "vat_amount": 0, "vat_percentage": 0, "quantity": 5, "unit_of_measurement": "", "sku": "", "vat_code": ""}, {"title": "[FURN_8220] Four Person Desk 5.00 Units 2,350.00 15.00% 11,750.00\nFour person modern office workstation", "description": "", "amount": 1175000, "amount_each": 235000, "amount_ex_vat": 1175000, "vat_amount": 0, "vat_percentage": 0, "quantity": 5, "unit_of_measurement": "", "sku": "", "vat_code": ""}, {"title": "Untaxed Amount 19,250.00", "description": "", "amount": 1925000, "amount_each": 1925000, "amount_ex_vat": 1925000, "vat_amount": 0, "vat_percentage": 0, "quantity": 1, "unit_of_measurement": "", "sku": "", "vat_code": ""}]}], "paymentmethod": "", "payment_auth_code": "", "payment_card_number": "", "payment_card_account_number": "", "payment_card_bank": "", "payment_card_issuer": "", "payment_due_date": "2022-03-10T00:00:00", "terminal_number": "", "document_subject": "", "package_number": "", "invoice_number": "INV/2022/00003", "invoice_type": "invoice", "receipt_number": "INV/2022/00003", "shop_number": "", "transaction_number": "", "transaction_reference": "", "order_number": "", "table_number": "", "table_group": "", "server": "", "merchant_name": "Deco Addict", "merchant_id": "", "merchant_coc_number": "", "merchant_vat_number": "", "merchant_fiscal_number": "", "merchant_bank_account_number": "", "merchant_bank_account_number_bic": "", "merchant_chain_liability_bank_account_number": "", "merchant_chain_liability_amount": 0, "merchant_bank_domestic_account_number": "", "merchant_bank_domestic_bank_code": "", "merchant_website": "", "merchant_email": "", "merchant_address": "Santa Barbara Rd 77", "merchant_street_name": "Santa Barbara Rd", "merchant_house_number": "77", "merchant_zipcode": "94523", "merchant_city": "Pleasant Hill", "merchant_municipality": "", "merchant_province": "", "merchant_country": "", "merchant_country_code": "US", "merchant_phone": "", "merchant_main_activity_code": "", "customer_name": "Your Logo", "customer_number": "", "customer_reference": "", "customer_address": "", "customer_street_name": "", "customer_house_number": "", "customer_zipcode": "", "customer_city": "", "customer_municipality": "", "customer_province": "", "customer_country": "", "customer_phone": "", "customer_vat_number": "", "customer_fiscal_number": "", "customer_coc_number": "", "customer_bank_account_number": "", "customer_bank_account_number_bic": "", "customer_website": "", "customer_email": "", "payment_slip_code": "", "payment_slip_reference_number": "", "payment_slip_customer_number": "", "document_language": "EN", "personal_income_tax_amount": 0, "personal_income_tax_rate": 0, "project_code": "", "matched_keywords": null, "matched_lineitems": null, "matched_purchase_order_id": "", "matched_project_code_id": "", "barcodes": null, "hash": "13e5e17a69863055ca148b643db8c72161683ed2", "hash_duplicate": true, "raw_text": "to Your logo\n Deco Addict\n 77 Santa Barbara Rd\n Pleasant Hill CA 94523\n United States\nInvoice INV/2022/00003\nInvoice Date: Due Date:\n02/08/2022 03/10/2022\nDescription Quantity Unit Price Taxes Amount\n[FURN_8999] Three-Seat Sofa 5.00 Units 1,500.00 15.00% $7,500.00\nThree Seater Sofa with Lounger in Steel Grey Colour\n[FURN_8220] Four Person Desk 5.00 Units 2,350.00 15.00% $ 11,750.00\nFour person modern office workstation\n Untaxed Amount $ 19,250.00\n Tax 15% $ 2,887.50\n Total $ 22,137.50\nPlease use the following communication for your payment : INV/2022/00003\nPayment terms: 30 Days\nTerms & Conditions: http://localhost:8069/terms\n Page: 1/1"}, "fields": null, "quality": {"blurriness": 0, "over_exposed": 0, "under_exposed": 0, "characters": 0, "unsupported_chars": 0, "non_text_chars": 0, "unknown_document_type": 0}, "vision_files": null, "raw_text": "to Your logo\n Deco Addict\n 77 Santa Barbara Rd\n Pleasant Hill CA 94523\n United States\nInvoice INV/2022/00003\nInvoice Date: Due Date:\n02/08/2022 03/10/2022\nDescription Quantity Unit Price Taxes Amount\n[FURN_8999] Three-Seat Sofa 5.00 Units 1,500.00 15.00% $7,500.00\nThree Seater Sofa with Lounger in Steel Grey Colour\n[FURN_8220] Four Person Desk 5.00 Units 2,350.00 15.00% $ 11,750.00\nFour person modern office workstation\n Untaxed Amount $ 19,250.00\n Tax 15% $ 2,887.50\n Total $ 22,137.50\nPlease use the following communication for your payment : INV/2022/00003\nPayment terms: 30 Days\nTerms & Conditions: http://localhost:8069/terms\n Page: 1/1", "hash": "13e5e17a69863055ca148b643db8c72161683ed2", "hash_duplicate": true}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"parsed": {"type": "object", "properties": {"document_type": {"type": "string"}, "amount": {"type": "integer"}, "amount_change": {"type": "integer"}, "amount_shipping": {"type": "integer"}, "amount_tip": {"type": "integer"}, "vatamount": {"type": "integer"}, "amountexvat": {"type": "integer"}, "currency": {"type": "string"}, "date": {"type": "string"}, "purchasedate": {"type": "string"}, "purchasetime": {"type": "string"}, "date_of_arrival": {"type": "string"}, "date_of_departure": {"type": "string"}, "vatitems": {"type": "array"}, "vat_context": {"type": "string"}, "lines": {"type": "array", "items": {"type": "object", "properties": {"description": {"type": "string"}, "lineitems": {"type": "array", "items": {"type": "object", "properties": {"title": {"type": "string"}, "description": {"type": "string"}, "amount": {"type": "integer"}, "amount_each": {"type": "integer"}, "amount_ex_vat": {"type": "integer"}, "vat_amount": {"type": "integer"}, "vat_percentage": {"type": "integer"}, "quantity": {"type": "integer"}, "unit_of_measurement": {"type": "string"}, "sku": {"type": "string"}, "vat_code": {"type": "string"}}, "required": ["amount", "amount_each", "amount_ex_vat", "description", "quantity", "sku", "title", "unit_of_measurement", "vat_amount", "vat_code", "vat_percentage"]}}}, "required": ["description", "lineitems"]}}, "paymentmethod": {"type": "string"}, "payment_auth_code": {"type": "string"}, "payment_card_number": {"type": "string"}, "payment_card_account_number": {"type": "string"}, "payment_card_bank": {"type": "string"}, "payment_card_issuer": {"type": "string"}, "payment_due_date": {"type": "string"}, "terminal_number": {"type": "string"}, "document_subject": {"type": "string"}, "package_number": {"type": "string"}, "invoice_number": {"type": "string"}, "invoice_type": {"type": "string"}, "receipt_number": {"type": "string"}, "shop_number": {"type": "string"}, "transaction_number": {"type": "string"}, "transaction_reference": {"type": "string"}, "order_number": {"type": "string"}, "table_number": {"type": "string"}, "table_group": {"type": "string"}, "server": {"type": "string"}, "merchant_name": {"type": "string"}, "merchant_id": {"type": "string"}, "merchant_coc_number": {"type": "string"}, "merchant_vat_number": {"type": "string"}, "merchant_fiscal_number": {"type": "string"}, "merchant_bank_account_number": {"type": "string"}, "merchant_bank_account_number_bic": {"type": "string"}, "merchant_chain_liability_bank_account_number": {"type": "string"}, "merchant_chain_liability_amount": {"type": "integer"}, "merchant_bank_domestic_account_number": {"type": "string"}, "merchant_bank_domestic_bank_code": {"type": "string"}, "merchant_website": {"type": "string"}, "merchant_email": {"type": "string"}, "merchant_address": {"type": "string"}, "merchant_street_name": {"type": "string"}, "merchant_house_number": {"type": "string"}, "merchant_zipcode": {"type": "string"}, "merchant_city": {"type": "string"}, "merchant_municipality": {"type": "string"}, "merchant_province": {"type": "string"}, "merchant_country": {"type": "string"}, "merchant_country_code": {"type": "string"}, "merchant_phone": {"type": "string"}, "merchant_main_activity_code": {"type": "string"}, "customer_name": {"type": "string"}, "customer_number": {"type": "string"}, "customer_reference": {"type": "string"}, "customer_address": {"type": "string"}, "customer_street_name": {"type": "string"}, "customer_house_number": {"type": "string"}, "customer_zipcode": {"type": "string"}, "customer_city": {"type": "string"}, "customer_municipality": {"type": "string"}, "customer_province": {"type": "string"}, "customer_country": {"type": "string"}, "customer_phone": {"type": "string"}, "customer_vat_number": {"type": "string"}, "customer_fiscal_number": {"type": "string"}, "customer_coc_number": {"type": "string"}, "customer_bank_account_number": {"type": "string"}, "customer_bank_account_number_bic": {"type": "string"}, "customer_website": {"type": "string"}, "customer_email": {"type": "string"}, "payment_slip_code": {"type": "string"}, "payment_slip_reference_number": {"type": "string"}, "payment_slip_customer_number": {"type": "string"}, "document_language": {"type": "string"}, "personal_income_tax_amount": {"type": "integer"}, "personal_income_tax_rate": {"type": "integer"}, "project_code": {"type": "string"}, "matched_keywords": {"type": "null"}, "matched_lineitems": {"type": "null"}, "matched_purchase_order_id": {"type": "string"}, "matched_project_code_id": {"type": "string"}, "barcodes": {"type": "null"}, "hash": {"type": "string"}, "hash_duplicate": {"type": "boolean"}, "raw_text": {"type": "string"}}, "required": ["amount", "amount_change", "amount_shipping", "amount_tip", "amountexvat", "barcodes", "currency", "customer_address", "customer_bank_account_number", "customer_bank_account_number_bic", "customer_city", "customer_coc_number", "customer_country", "customer_email", "customer_fiscal_number", "customer_house_number", "customer_municipality", "customer_name", "customer_number", "customer_phone", "customer_province", "customer_reference", "customer_street_name", "customer_vat_number", "customer_website", "customer_zipcode", "date", "date_of_arrival", "date_of_departure", "document_language", "document_subject", "document_type", "hash", "hash_duplicate", "invoice_number", "invoice_type", "lines", "matched_keywords", "matched_lineitems", "matched_project_code_id", "matched_purchase_order_id", "merchant_address", "merchant_bank_account_number", "merchant_bank_account_number_bic", "merchant_bank_domestic_account_number", "merchant_bank_domestic_bank_code", "merchant_chain_liability_amount", "merchant_chain_liability_bank_account_number", "merchant_city", "merchant_coc_number", "merchant_country", "merchant_country_code", "merchant_email", "merchant_fiscal_number", "merchant_house_number", "merchant_id", "merchant_main_activity_code", "merchant_municipality", "merchant_name", "merchant_phone", "merchant_province", "merchant_street_name", "merchant_vat_number", "merchant_website", "merchant_zipcode", "order_number", "package_number", "payment_auth_code", "payment_card_account_number", "payment_card_bank", "payment_card_issuer", "payment_card_number", "payment_due_date", "payment_slip_code", "payment_slip_customer_number", "payment_slip_reference_number", "paymentmethod", "personal_income_tax_amount", "personal_income_tax_rate", "project_code", "purchasedate", "purchasetime", "raw_text", "receipt_number", "server", "shop_number", "table_group", "table_number", "terminal_number", "transaction_number", "transaction_reference", "vat_context", "vatamount", "vatitems"]}, "fields": {"type": "null"}, "quality": {"type": "object", "properties": {"blurriness": {"type": "integer"}, "over_exposed": {"type": "integer"}, "under_exposed": {"type": "integer"}, "characters": {"type": "integer"}, "unsupported_chars": {"type": "integer"}, "non_text_chars": {"type": "integer"}, "unknown_document_type": {"type": "integer"}}, "required": ["blurriness", "characters", "non_text_chars", "over_exposed", "under_exposed", "unknown_document_type", "unsupported_chars"]}, "vision_files": {"type": "null"}, "raw_text": {"type": "string"}, "hash": {"type": "string"}, "hash_duplicate": {"type": "boolean"}}, "required": ["fields", "hash", "hash_duplicate", "parsed", "quality", "raw_text", "vision_files"]}
852312bc-151d-4023-8155-a89d08bc86fa/06b533d9-6f50-41bd-aa39-82b496f147a9/0/0
VAT validation and tax rates
Stay compliant with our simple, reliable, and powerful API for all your domestic and cross-border sales. The VAT Validation and Rates API makes it easy to stay compliant with VAT laws Reliable and up-to-date VAT data
8.1
VAT validation API endpoint
The Validate Endpoint takes a VAT number in the request, checks if that number is valid, and if it is valid, returns addition details about the company associated with that VAT number.
200
Response
{"vat_number": "SE556656688001", "valid": true, "company": {"name": "GOOGLE SWEDEN AB", "address": "GOOGLE IRLAND LTD \nM COLLINS, GORDON HOUSE \nBARROW STREET, DUBLIN 4 \nIRLAND"}, "country": {"code": "SE", "name": "Sweden"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"vat_number": {"type": "string"}, "valid": {"type": "boolean"}, "company": {"type": "object", "properties": {"name": {"type": "string"}, "address": {"type": "string"}}, "required": ["address", "name"]}, "country": {"type": "object", "properties": {"code": {"type": "string"}, "name": {"type": "string"}}, "required": ["code", "name"]}}, "required": ["company", "country", "valid", "vat_number"]}
852312bc-151d-4023-8155-a89d08bc86fa/321fccf2-4ff1-4673-a69e-45847dbcf734/0/0
VAT validation and tax rates
Stay compliant with our simple, reliable, and powerful API for all your domestic and cross-border sales. The VAT Validation and Rates API makes it easy to stay compliant with VAT laws Reliable and up-to-date VAT data
8.1
VAT rates & categories API endpoint
The /categories/ endpoint makes it easy to get the latest VAT rates, including the reduced rates for certain categories, for a specific country.
200
Response
[{"country_code": "DE", "rate": "0.070", "category": "water", "description": "Supply of water. No reduced rate for bottled water."}, {"country_code": "DE", "rate": "0.070", "category": "foodstuffs", "description": "Foodstuffs (including beverages but excluding alcoholic beverages) for human and animal consumption; live animals, seeds, plants and ingredients normally intended for use in the preparation of foodstuffs; products normally used to supplement foodstuffs or as a substitute for foodstuffs. Reduced rate only on part of the items."}, {"country_code": "DE", "rate": "0.070", "category": "sculpture art", "description": "Original sculptures and statuary, in any material, provided that they are executed entirely by the artists."}, {"country_code": "DE", "rate": "0.070", "category": "social welfare goods", "description": "Supply of goods and services by organisations recognised as being devoted to social wellbeing by Member States and engaged in welfare or social security work."}, {"country_code": "DE", "rate": "0.070", "category": "art services", "description": "Supply of services by writers, composers and performing artists, or of the royalties due to them."}, {"country_code": "DE", "rate": "0.070", "category": "newspapers", "description": "Newspapers. Reduced rate not applicable to newspapers whose content is harmful to minors or is predominatly devoted to advertising."}, {"country_code": "DE", "rate": "0.070", "category": "description", "description": "Pictures, collages and similar decorative plaques, paintings and drawings, executed entirely by hand by the artist, other than plans and drawings for architectural, engineering, industrial, commercial, topographical or similar purposes, hand-decorated manufactured articles, theatrical scenery, studio back cloths or the like of painted canvas (CN code 9701)."}, {"country_code": "DE", "rate": "0.070", "category": "medical", "description": "Provision of medical and dental care and thermal treatment. Reduced rate on part of the items."}, {"country_code": "DE", "rate": "0.070", "category": "engravings prints lithographs", "description": "Original engravings, prints and lithographs, being impressions produced in the limited numbers directly in black and white or in colour of one or of several plates executed entirely by hand by the artist, irrespective of the process or of the material employed, but not including any mechanical or photomechanical process (CN code 9702 00 00)."}, {"country_code": "DE", "rate": "0.070", "category": "passenger transport", "description": "Transport of passengers and their accompanying luggage. Reduced rate on local transport and rail-bound transport in long-distance."}, {"country_code": "DE", "rate": "0.070", "category": "accommodation", "description": "Accommodation provided in hotels and similar establishments, including the provision of holiday accommodation and the letting of places on camping or caravan sites. Only for short-term accommodation."}, {"country_code": "DE", "rate": "0.070", "category": "periodicals", "description": "Periodicals. Reduced rate not applicable to periodicals whose content is harmful to minors or is predominatly devoted to advertising."}, {"country_code": "DE", "rate": "0.070", "category": "admission to entertainment events", "description": "Admission to shows, theatres, circuses, fairs, amusement parks, concerts, museums, zoos, cinemas, exhibitions and similar cultural events and facilities. Reduced rate only on part of the items."}, {"country_code": "DE", "rate": "0.070", "category": "sculpture cast art", "description": "Sculpture casts the production of which is limited to eight copies and supervised by the artist or his successors in title (CN code 9703 00 00) on an exceptional basis, in cases determined by the Member States, the limit of eight copies may be exceeded for statuary casts produced before 1 January 1989."}, {"country_code": "DE", "rate": "0.190", "category": "collections or collectors pieces", "description": "Collections and collector\u2019s pieces of zoological, botanical, mineralogical, ethnographic or numismatic interest (CN code 9705 00 00)."}, {"country_code": "DE", "rate": "0.190", "category": "standard", "description": ""}, {"country_code": "DE", "rate": "0.070", "category": "books", "description": "Supply, including on loan by libraries, of books, newspapers and periodicals either on physical means of support or supplied electronically or both (including brochures, leaflets and similar printed matter, children's picture, drawing or colouring books, music printed or in manuscript form, maps and hydrographic or similar charts), other than publications wholly or predominantly devoted to advertising and other than publications wholly or predominantly consisting of video content or audible music. Reduced rate only on part of the items."}, {"country_code": "DE", "rate": "0.070", "category": "picture art", "description": "Pictures, collages and similar decorative plaques, paintings and drawings, executed entirely by hand by the artist, other than plans and drawings for architectural, engineering, industrial, commercial, topographical or similar purposes, hand-decorated manufactured articles, theatrical scenery, studio back cloths or the like of painted canvas (CN code 9701)."}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"country_code": {"type": "string"}, "rate": {"type": "string"}, "category": {"type": "string"}, "description": {"type": "string"}}, "required": ["category", "country_code", "description", "rate"]}}
852312bc-151d-4023-8155-a89d08bc86fa/fe741fc2-3721-4d0b-8f0e-32624466f10b/0/0
VAT validation and tax rates
Stay compliant with our simple, reliable, and powerful API for all your domestic and cross-border sales. The VAT Validation and Rates API makes it easy to stay compliant with VAT laws Reliable and up-to-date VAT data
8.1
VAT price calculation API endpoint
The Calculate Endpoint makes it easy to calculate a VAT compliant price given a country and price, as well as such optional values as the type of goods.
200
Response
{"amount_excluding_vat": "500.00", "amount_including_vat": "535.00", "vat_amount": "35.00", "vat_category": "books", "vat_rate": "0.070", "country": {"code": "DE", "name": "Germany"}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"amount_excluding_vat": {"type": "string"}, "amount_including_vat": {"type": "string"}, "vat_amount": {"type": "string"}, "vat_category": {"type": "string"}, "vat_rate": {"type": "string"}, "country": {"type": "object", "properties": {"code": {"type": "string"}, "name": {"type": "string"}}, "required": ["code", "name"]}}, "required": ["amount_excluding_vat", "amount_including_vat", "country", "vat_amount", "vat_category", "vat_rate"]}
ced018d5-0826-4dc8-8738-0f41665a6b0e/ea3b87e8-1a9b-41f1-bfea-7f753f6bd79f/0/0
Crunchbase
Crunchbase Company API
0.3
Company Info
Provides access to scraped crunchbase company data.
200
Response
{"uuid": "0d2b82ad-bd6f-9f54-c76a-448a455af317", "name": "Airbus", "permalink": "airbus-group", "website": "http://www.airbus.com", "aliases": ["EADS", "Airbus Group"], "founded": "1970-12-18", "operating_status": "active", "tags": null, "headline": "Airbus is an aircraft manufacturer whose customer focus, commercial know-how, technological leadership, and manufacturing efficiency.", "description": "Airbus is an aircraft manufacturer whose customer focus, commercial know-how, technological leadership, and manufacturing efficiency have propelled it to the forefront of the industry.\n\nThe company was founded in 1970 and headquartered in Midi-Pyrenees, France.", "funding_rounds_headline": {}, "semrush_summary": {"semrush_global_rank": 29039, "semrush_visits_latest_month": 3413758}, "categories": [{"uuid": "8a20023f-3e32-20bb-b6ab-e824a0386367", "permalink": "aerospace-8a20", "name": "Aerospace"}, {"uuid": "f0193199-a968-b457-eb49-95344e22a5ce", "permalink": "industrial", "name": "Industrial"}, {"uuid": "e811671c-168d-1fd2-36e5-df4e08a09f7c", "permalink": "manufacturing", "name": "Manufacturing"}, {"uuid": "a05dcda6-3d19-288d-9b66-1473706720aa", "permalink": "product-design", "name": "Product Design"}, {"uuid": "f213df87-6356-e51f-245a-cf9b7e788b13", "permalink": "product-research", "name": "Product Research"}], "location": [{"uuid": "d16a251c-5356-526e-1ddc-ca5c64159067", "permalink": "blagnac-midi-pyrenees", "name": "Blagnac", "type": "city"}, {"uuid": "1a861023-733e-5f71-de78-6ae8f0ef18bd", "permalink": "midi-pyrenees-france", "name": "Midi-Pyrenees", "type": "region"}, {"uuid": "f134827e-36a1-fd31-a82f-950489e103ef", "permalink": "france", "name": "France", "type": "country"}, {"uuid": "6106f5dc-823e-5da8-40d7-51612c0b2c4e", "permalink": "europe", "name": "Europe", "type": "continent"}]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"uuid": {"type": "string"}, "name": {"type": "string"}, "permalink": {"type": "string"}, "website": {"type": "string"}, "aliases": {"type": "array", "items": {"type": "string"}}, "founded": {"type": "string"}, "operating_status": {"type": "string"}, "tags": {"type": "null"}, "headline": {"type": "string"}, "description": {"type": "string"}, "funding_rounds_headline": {"type": "object"}, "semrush_summary": {"type": "object", "properties": {"semrush_global_rank": {"type": "integer"}, "semrush_visits_latest_month": {"type": "integer"}}, "required": ["semrush_global_rank", "semrush_visits_latest_month"]}, "categories": {"type": "array", "items": {"type": "object", "properties": {"uuid": {"type": "string"}, "permalink": {"type": "string"}, "name": {"type": "string"}}, "required": ["name", "permalink", "uuid"]}}, "location": {"type": "array", "items": {"type": "object", "properties": {"uuid": {"type": "string"}, "permalink": {"type": "string"}, "name": {"type": "string"}, "type": {"type": "string"}}, "required": ["name", "permalink", "type", "uuid"]}}}, "required": ["aliases", "categories", "description", "founded", "funding_rounds_headline", "headline", "location", "name", "operating_status", "permalink", "semrush_summary", "tags", "uuid", "website"]}
e02a56a6-3a80-47f7-957b-01d9ddb46b9c/6dbad7ff-8eaf-4ecb-93e2-bf45fd5a9640/0/0
Pets
this is a test api
null
Retrieve a dog profile
this is a test
200
New Example
{"id": 100000, "name": "happy", "address": "xxxxxxxxxxxxxxxxxxx"}
{"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "address": {"type": "string"}}}
e02a56a6-3a80-47f7-957b-01d9ddb46b9c/a78e1d06-2b37-495e-988e-5ab5872dd26b/0/0
Pets
this is a test api
null
Create a dog profile
this is a test
200
New Example
{"id": 10000, "name": "happy", "address": "Road 5, Beijing"}
{"type": "object", "properties": {"id": {"type": "integer"}, "name": {"type": "string"}, "address": {"type": "string"}}}
7ec9600b-2de8-4707-9e15-9b7a8b11c339/513ffafa-348d-45e3-9b66-127651fb8a72/0/0
Statistical Process Control
Statistical Process Control (SPC) is a statistical method to measure, monitor, and control a process. It is a scientific visual method to monitor, control, and improve the process by eliminating special cause variation in a process.
null
Continuous Variable Details
Continuous value control charts are graphical displays of quality characteristics that have been measured or computed from a sample versus the sample number or time. Furthermore, these control charts contain a center line representing the average value of the quality characteristics and two other horizontal lines known as upper control limit (UCL) and lower control limit (LCL) .
200
Example_1
[{"n": "[1, 2)", "kind": "X-MR", "description": "Individual (X) and Moving Range (MR) charts track process variability based on the samples taken from a process over the period of time."}, {"n": "[2, 10)", "kind": "Xbar-R", "description": "Subgroup average (X-bar) and Subgroup Range (R) charts monitor the process performance of a continuous data collected in subgroups at set time periods."}, {"n": "[10, 25]", "kind": "Xbar-S", "description": "Subgroup average (X-bar) and Subgroup Deviation (S) charts examine the process performance of a continuous data collected in subgroups at set time periods where in the case of a large sample size in the subgroup (n), the standard deviation is better measure of variation than the range because it considers all the data not just minimum and maximum values."}]
{"$schema": "http://json-schema.org/schema#", "type": "array", "items": {"type": "object", "properties": {"n": {"type": "string"}, "kind": {"type": "string"}, "description": {"type": "string"}}, "required": ["description", "kind", "n"]}}
2140e3d5-6797-4205-a99a-2a1cf156d561/b4ac05ad-835d-4ad7-b3a1-adb711f8a6c6/0/0
German Companies API
Fresh company data & numbers for more than 663,425 companies in 🇩🇪 Germany: Address, email, capital, people & more.
null
search
Search companies based on company name and location. Returns the number of matches, along with a list of companies. Results from this endpoint contain only company name, company ID and a list of data available for this company. The actual data can then be accessed using the /details endpoint. The result list is paginated to 25 items per page, and you can request any page.
200
Response
{"match_count": 10, "pages": {"total": 1, "current": 1, "next": null}, "results": [{"name": "e*Dispatch Professional Mobile Radio GmbH", "adress_city": "Berlin", "company_id": "company_QR7LQSGGQQ79", "available_data": ["adress_country", "adress_street", "adress_zip", "balance_str", "balance_int", "capital_str", "date_incorporated", "email", "fax", "geo_latlong", "phone", "purpose", "register", "www", "people"]}, {"name": "e*Message Wireless Information Services Deutschland GmbH", "adress_city": "Berlin", "company_id": "company_QRGGS0FXDH52", "available_data": ["adress_country", "adress_street", "adress_zip", "balance_str", "balance_int", "capital_str", "date_incorporated", "email", "fax", "geo_latlong", "phone", "register", "www", "people"]}, {"name": "e*Message Wireless Information Services GmbH", "adress_city": "Berlin", "company_id": "company_QR6MJRTGSE96", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "capital_int", "date_incorporated", "geo_latlong", "purpose", "register"]}, {"name": "Waldorf-Bildungs-Seminar Berlin gGmbH Seminar f\u00fcr die Ausbildung von Waldorferzieher*innen", "adress_city": "Berlin", "company_id": "company_QRD7PYQNNP88", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "date_incorporated", "email", "geo_latlong", "phone", "purpose", "register", "www", "people"]}, {"name": "3BE*Veranstaltungs-GmbH", "adress_city": "Berlin", "company_id": "company_QRYQNSEIL027", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "date_incorporated", "geo_latlong", "purpose", "register", "people"]}, {"name": "die erfahrungsexpert*innen gemeinn\u00fctzige UG (haftungsbeschr\u00e4nkt)", "adress_city": "Berlin", "company_id": "company_QRY9ZIW7R094", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "date_incorporated", "email", "geo_latlong", "phone", "purpose", "register", "www", "people"]}, {"name": "e*Message Wireless Information Service Center GmbH", "adress_city": "Berlin", "company_id": "company_QRT33AQWMP18", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "date_incorporated", "geo_latlong", "register", "people"]}, {"name": "BGHP-Berger Gro\u00df H\u00f6hmann Partnerschaft von Rechtsanw\u00e4lt*innen mbB", "adress_city": "Berlin", "company_id": "company_QRDD1KUR7E06", "available_data": ["adress_country", "adress_street", "adress_zip", "date_incorporated", "email", "fax", "geo_latlong", "phone", "purpose", "register", "www"]}, {"name": "parkgalerie berlin Bildende K\u00fcnstler*innen Birgit Kelly, Skarlett R\u00f6hner, Klaus Wegmann Partnerschaft", "adress_city": "Berlin", "company_id": "company_QR0KL5ZBZT95", "available_data": ["adress_country", "adress_street", "adress_zip", "date_incorporated", "email", "geo_latlong", "phone", "purpose", "register", "www"]}, {"name": "Andreas Butze * Dienstleistungsgesellschaft mbH *", "adress_city": "Berlin", "company_id": "company_QR5NNIG5M235", "available_data": ["adress_country", "adress_street", "adress_zip", "capital_str", "date_incorporated", "geo_latlong", "register"]}], "help": "To fetch the data listed under \"available_data\", pass the company_id to the /details endpoint."}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"match_count": {"type": "integer"}, "pages": {"type": "object", "properties": {"total": {"type": "integer"}, "current": {"type": "integer"}, "next": {"type": "null"}}, "required": ["current", "next", "total"]}, "results": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "adress_city": {"type": "string"}, "company_id": {"type": "string"}, "available_data": {"type": "array", "items": {"type": "string"}}}, "required": ["adress_city", "available_data", "company_id", "name"]}}, "help": {"type": "string"}}, "required": ["help", "match_count", "pages", "results"]}
2140e3d5-6797-4205-a99a-2a1cf156d561/1f8b90ff-b2d4-4ff8-9404-092116ec7b55/0/0
German Companies API
Fresh company data & numbers for more than 663,425 companies in 🇩🇪 Germany: Address, email, capital, people & more.
null
details
Fetch all available data for the given company, identified by its company_id.
200
Response
{"name": "Deutsche Telekom AG", "adress_city": "Bonn", "adress_country": "Germany", "adress_street": "Friedrich-Ebert-Allee 140", "adress_zip": "53113", "balance_str": "124,1 Mrd. \u20ac", "balance_int": null, "capital_str": "12.765.334.005,76 \u20ac", "capital_int": 12765334005, "date_incorporated": "1995-01-02T00:00:00", "email": null, "fax": "+49 228 18188899", "geo_latlong": "(50.707856, 7.129003)", "phone": "+49 228 1810", "purpose": "Die Bet\u00e4tigung im gesamten Bereich der Telekommunikation, Informationstechnologie, Multimedia, Information und Unterhaltung (einschlie\u00dflich Gl\u00fccksspiel- oder Wettgesch\u00e4ft), der Sicherheitsdienstleistungen, Vertriebs- und Vermittlungsdienstleistungen, des E-Banking, E-Money und sonstiger Zahlungsl\u00f6sungen, des Inkasso, Factoring und der Empfangs- und Bewachungsleistungen sowie der mit diesen Bereichen im Zusammenhang stehenden Serviceleistungen und in verwandten Bereichen im In- und Ausland. Dar\u00fcber hinaus geh\u00f6rt zum Gegenstand des Unternehmens die Bet\u00e4tigung im Bereich Venture Capital (Risikokapital), einschlie\u00dflich des Erwerbs, Haltens, Verwaltens und der Ver\u00e4u\u00dferung von Venture Capital-Beteiligungen, insbesondere, aber nicht ausschlie\u00dflich, an Unternehmen, die in den in Satz 1 genannten Bereichen t\u00e4tig sind. Daneben geh\u00f6rt zum Gegenstand des Unternehmens auch die Bet\u00e4tigung im Bereich R\u00fcckversicherung im Zusammenhang mit den in Satz 1 genannten Bereichen; diese Bet\u00e4tigung darf nicht unmittelbar durch die Gesellschaft selbst erfolgen.", "register": "Bonn HRB 6794", "www": "http://www.telekom.com/", "people": [{"familyName": "Al-Saleh", "givenName": "Adel", "name": "Adel Al-Saleh", "jobTitle": "Vorstand"}, {"familyName": "Bohle", "givenName": "Birgit", "name": "Birgit Bohle", "jobTitle": "Vorstand"}, {"familyName": "Nemat", "givenName": "Claudia", "name": "Claudia Nemat", "jobTitle": "Vorstand"}, {"familyName": "Leroy", "givenName": "Dominique", "name": "Dominique Leroy", "jobTitle": "Vorstand"}, {"familyName": "Illek", "givenName": "Christian Peter", "name": "Dr. Christian Peter Illek", "jobTitle": "Vorstand", "honorificPrefix": "Dr."}, {"familyName": "Gopalan", "givenName": "Srinivasan", "name": "Srinivasan Gopalan", "jobTitle": "Vorstand"}, {"familyName": "Langheim", "givenName": "Thorsten", "name": "Thorsten Langheim", "jobTitle": "Vorstand"}, {"familyName": "H\u00f6ttges", "givenName": "Timotheus", "name": "Timotheus H\u00f6ttges", "jobTitle": "Vorstand"}], "company_id": "company_QRVROMUZFI33", "request_params": {"company_id": "company_QRVROMUZFI33", "return_request_params": true}}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"name": {"type": "string"}, "adress_city": {"type": "string"}, "adress_country": {"type": "string"}, "adress_street": {"type": "string"}, "adress_zip": {"type": "string"}, "balance_str": {"type": "string"}, "balance_int": {"type": "null"}, "capital_str": {"type": "string"}, "capital_int": {"type": "integer"}, "date_incorporated": {"type": "string"}, "email": {"type": "null"}, "fax": {"type": "string"}, "geo_latlong": {"type": "string"}, "phone": {"type": "string"}, "purpose": {"type": "string"}, "register": {"type": "string"}, "www": {"type": "string"}, "people": {"type": "array", "items": {"type": "object", "properties": {"familyName": {"type": "string"}, "givenName": {"type": "string"}, "name": {"type": "string"}, "jobTitle": {"type": "string"}, "honorificPrefix": {"type": "string"}}, "required": ["familyName", "givenName", "jobTitle", "name"]}}, "company_id": {"type": "string"}, "request_params": {"type": "object", "properties": {"company_id": {"type": "string"}, "return_request_params": {"type": "boolean"}}, "required": ["company_id", "return_request_params"]}}, "required": ["adress_city", "adress_country", "adress_street", "adress_zip", "balance_int", "balance_str", "capital_int", "capital_str", "company_id", "date_incorporated", "email", "fax", "geo_latlong", "name", "people", "phone", "purpose", "register", "request_params", "www"]}
d7649861-9ef1-4ac8-9895-02640f187532/9b1c662d-86e7-4f68-93e8-2566a8dd1690/2/0
NY Times - Article Search
NY Times - Article Search
null
/articlesearch.json
Search for NYT articles by keywords, filters and facets.
200
null
{"status": "", "copyright": "", "response": {"docs": [{"web_url": "", "snippet": "", "print_page": 0, "print_section": "", "source": "", "multimedia": [{"rank": 0, "subtype": "", "caption": "", "credit": "", "type": "", "url": "", "height": 0, "width": 0, "legacy": {}, "crop_name": ""}], "headline": {"main": "", "kicker": "", "content_kicker": "", "print_headline": "", "name": "", "seo": "", "sub": ""}, "keywords": [{"name": "", "value": "", "rank": 0, "major": ""}], "pub_date": "", "document_type": "", "news_desk": "", "section_name": "", "byline": {"original": "", "person": [], "organization": ""}, "type_of_material": "", "_id": "", "word_count": 0, "uri": ""}], "meta": {"hits": 0, "offset": 0, "time": 0}}}
{"type": "object", "properties": {"status": {"type": "string"}, "copyright": {"type": "string"}, "response": {"type": "object", "properties": {"docs": {"type": "array", "items": {"type": "object", "properties": {"web_url": {"type": "string", "description": "Article URL."}, "snippet": {"type": "string"}, "print_page": {"type": "integer", "description": "Page in print (e.g. 1)."}, "print_section": {"type": "string", "description": "Section in print (e.g. A)."}, "source": {"type": "string"}, "multimedia": {"type": "array", "items": {"type": "object", "properties": {"rank": {"type": "integer"}, "subtype": {"type": "string"}, "caption": {"type": "string"}, "credit": {"type": "string"}, "type": {"type": "string"}, "url": {"type": "string"}, "height": {"type": "integer"}, "width": {"type": "integer"}, "legacy": {"type": "object", "properties": {"xlarge": {"description": "**Omitted**"}, "xlargewidth": {"description": "**Omitted**"}, "xlargeheight": {"description": "**Omitted**"}}}, "crop_name": {"type": "string"}}}}, "headline": {"type": "object", "properties": {"main": {"type": "string"}, "kicker": {"type": "string"}, "content_kicker": {"type": "string"}, "print_headline": {"type": "string"}, "name": {"type": "string"}, "seo": {"type": "string"}, "sub": {"type": "string"}}}, "keywords": {"type": "array", "items": {"type": "object", "properties": {"name": {"type": "string"}, "value": {"type": "string"}, "rank": {"type": "integer"}, "major": {"type": "string"}}}}, "pub_date": {"type": "string", "description": "Publication date."}, "document_type": {"type": "string", "description": "Document type (article, multimedia)."}, "news_desk": {"type": "string", "description": "Desk in the newsroom that worked on the story (Foreign, Metro, Sports, ...)."}, "section_name": {"type": "string", "description": "Section that the article appeared in (New York, Sports, World, ...)."}, "byline": {"type": "object", "properties": {"original": {"type": "string"}, "person": {"type": "array", "items": {"type": "object", "properties": {"firstname": {"description": "**Omitted**"}, "middlename": {"description": "**Omitted**"}, "lastname": {"description": "**Omitted**"}, "qualifier": {"description": "**Omitted**"}, "title": {"description": "**Omitted**"}, "role": {"description": "**Omitted**"}, "organization": {"description": "**Omitted**"}, "rank": {"description": "**Omitted**"}}}}, "organization": {"type": "string"}}}, "type_of_material": {"type": "string", "description": "Type of asset (Correction, News, Op-Ed, Review, Video, ...)."}, "_id": {"type": "string"}, "word_count": {"type": "integer", "description": "Number of words in the article."}, "uri": {"type": "string", "description": "Uniquely identifies an asset."}}}}, "meta": {"type": "object", "properties": {"hits": {"type": "integer"}, "offset": {"type": "integer"}, "time": {"type": "integer"}}}}}}}