Products API (1.0.0)

Download OpenAPI specification:Download

Interface for products that live within our ERP.

Create a category

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

name

required

string

Responses

Request samples

Payload

Content type

application/json

{"name": "Retail"
}

Response samples

201
401
406
415

Content type

application/json

{"data": {"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Get all categories

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
406

Content type

application/json

{"data": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
]
}

/categories/{id}

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": {"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Fetch a paginated list of products for a category

Authorizations:

X-Api-Token

query Parameters

perPage	integer Example: perPage=50
page	integer Example: page=1

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"links": {"self": "/products?page=1",
"first": "/products?page=1",
"next": null,
"previous": null,
"last": "/products?page=1"
},
"data": [{"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"meta": {"total": 100,
"count": 10,
"perPage": 10,
"currentPage": 1,
"totalPages": 10
}
}

Fetch a paginated list of bundles for a category

Authorizations:

X-Api-Token

query Parameters

perPage	integer Example: perPage=50
page	integer Example: page=1

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"links": {"self": "/bundles?page=1",
"first": "/bundles?page=1",
"next": null,
"previous": null,
"last": "/bundles?page=1"
},
"data": [{"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
],
"meta": {"total": 100,
"count": 10,
"perPage": 10,
"currentPage": 1,
"totalPages": 10
}
}

product

Create a product

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

externalId required	string
name required	string
description	string or null
image	string or null
msrp	float or null
listPrice	float or null
digitalId	string or null
categories required	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": ["64269e44-b3cd-4a2c-ab4c-14f3713a180d",
"bd171163-49aa-4307-b2ee-7198037a6579"
]
}

Response samples

201
401
406
415

Content type

application/json

{"data": {"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Fetch a paginated list of products

Authorizations:

X-Api-Token

query Parameters

perPage	integer Example: perPage=50
page	integer Example: page=1
sortBy	string Example: sortBy=foo
sort	string Example: sort=desc
filter[attribute][_eq]	string Example: filter[attribute][_eq]=foo
filter[attribute][_lt]	string Example: filter[attribute][_lt]=2023-01-01 00:00:00
filter[attribute][_lte]	string Example: filter[attribute][_lte]=2023-01-01 00:00:00
filter[attribute][_gt]	string Example: filter[attribute][_gt]=2023-01-01 00:00:00
filter[attribute][_gte]	string Example: filter[attribute][_gte]=2023-01-01 00:00:00
filter[attribute][_in]	string Example: filter[attribute][_in]=foo,bar,baz
filter[attribute][_starts_with]	string Example: filter[attribute][_starts_with]=foo
filter[attribute][_ends_with]	string Example: filter[attribute][_ends_with]=foo
filter[attribute][_contains]	string Example: filter[attribute][_contains]=foo
filter[relationship][_has][column]	string Example: filter[relationship][_has][column]=foo

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
406

Content type

application/json

{"links": {"self": "/products?page=1",
"first": "/products?page=1",
"next": null,
"previous": null,
"last": "/products?page=1"
},
"data": [{"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"meta": {"total": 100,
"count": 10,
"perPage": 10,
"currentPage": 1,
"totalPages": 10
}
}

Find a product

Authorizations:

X-Api-Token

query Parameters

include[]

string

Enum: "categories" "bundles"

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": {"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Update a product

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

name	string
description	string
image	string
msrp	float
listPrice	float
digitalId	string or null
categories	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": ["64269e44-b3cd-4a2c-ab4c-14f3713a180d",
"bd171163-49aa-4307-b2ee-7198037a6579"
]
}

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
}

Delete a product

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Responses

Response samples

401
404
406

Content type

application/json

{"errors": [{"status": 401,
"title": "Unauthorized",
"message": "The api token is missing or invalid"
}
]
}

bundle

Create a bundle

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

externalId required	string
name required	string
description	string
image	string
msrp	float
startAt	string or null <date-time>
endAt	string or null <date-time>
categories required	Array of arrays
products required	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"startAt": "2022-08-01 00:00:00",
"endAt": "2022-12-31 23:59:00",
"categories": ["64269e44-b3cd-4a2c-ab4c-14f3713a180d",
"bd171163-49aa-4307-b2ee-7198037a6579"
],
"products": ["PRODUCT-SKU-1",
"PRODUCT-SKU-2"
]
}

Response samples

201
401
406
415

Content type

application/json

{"data": {"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
}

Fetch a paginated list of bundles

Authorizations:

X-Api-Token

query Parameters

perPage	integer Example: perPage=50
page	integer Example: page=1
sortBy	string Example: sortBy=foo
sort	string Example: sort=desc
filter[attribute][_eq]	string Example: filter[attribute][_eq]=foo
filter[attribute][_lt]	string Example: filter[attribute][_lt]=2023-01-01 00:00:00
filter[attribute][_lte]	string Example: filter[attribute][_lte]=2023-01-01 00:00:00
filter[attribute][_gt]	string Example: filter[attribute][_gt]=2023-01-01 00:00:00
filter[attribute][_gte]	string Example: filter[attribute][_gte]=2023-01-01 00:00:00
filter[attribute][_in]	string Example: filter[attribute][_in]=foo,bar,baz
filter[attribute][_starts_with]	string Example: filter[attribute][_starts_with]=foo
filter[attribute][_ends_with]	string Example: filter[attribute][_ends_with]=foo
filter[attribute][_contains]	string Example: filter[attribute][_contains]=foo
filter[relationship][_has][column]	string Example: filter[relationship][_has][column]=foo

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
406

Content type

application/json

{"links": {"self": "/bundles?page=1",
"first": "/bundles?page=1",
"next": null,
"previous": null,
"last": "/bundles?page=1"
},
"data": [{"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
],
"meta": {"total": 100,
"count": 10,
"perPage": 10,
"currentPage": 1,
"totalPages": 10
}
}

Find a bundle

Authorizations:

X-Api-Token

query Parameters

include[]

string

Enum: "categories" "products"

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": {"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
}

Update a bundle

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

name	string
description	string
image	string
msrp	float
startAt	string or null <date-time>
endAt	string or null <date-time>
isActivated	boolean
categories	Array of arrays
products	Array of arrays

Responses

Request samples

Payload

Content type

application/json

{"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"startAt": "2022-08-01 00:00:00",
"endAt": "2022-12-31 23:59:00",
"isActivated": false,
"categories": ["64269e44-b3cd-4a2c-ab4c-14f3713a180d",
"bd171163-49aa-4307-b2ee-7198037a6579"
],
"products": ["PRODUCT-SKU-1",
"PRODUCT-SKU-2"
]
}

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
}

Delete a bundle

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Responses

Response samples

401
404
406

Content type

application/json

{"errors": [{"status": 401,
"title": "Unauthorized",
"message": "The api token is missing or invalid"
}
]
}

Fetch a list of products for a bundle

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca

Responses

Response samples

200
401
404
406

Content type

application/json

{"data": [{"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00",
"price": 4.99
}
}
]
}

Update a bundle product instance

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Request Body schema: application/json
required

price

float

Responses

Request samples

Payload

Content type

application/json

{"price": 4.99
}

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "products",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "PRODUCT-SKU-1",
"name": "Product 1",
"description": "Product 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 6.99,
"listPrice": 6.99,
"digitalId": "ABCD1234",
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00",
"price": 4.99
}
}
}

Activate a bundle

Authorizations:

X-Api-Token

header Parameters

Accept required	string Default: application/json
Content-Type required	string Default: application/json
X-Api-Token required	string Default: fe0d9fc0-9975-43f2-b638-853a323505ca
X-Username required	string Default: admin@uscca.com
X-Password required	string Default: testPass123!

Responses

Response samples

200
401
404
406
415

Content type

application/json

{"data": {"type": "bundles",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"externalId": "BUNDLE-SKU-1",
"name": "Bundle 1",
"description": "Bundle 1",
"image": "https://cdn.uscca.com/image.jpg",
"msrp": 10.99,
"listPrice": 10.99,
"startAt": "2023-01-01 12:00:00",
"endAt": "2023-12-31 12:00:00",
"isActivated": true,
"categories": [{"type": "categories",
"id": "c8db31ad-10cd-40d8-a992-21183bd22c18",
"attributes": {"name": "category",
"createdAt": "2022-01-01 12:00:00",
"updatedAt": "2022-01-01 12:00:00"
}
}
],
"createdAt": "2023-01-01 12:00:00",
"updatedAt": "2023-01-01 12:00:00"
}
}
}

Products API (1.0.0)

category

Create a category

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get all categories

Authorizations:

header Parameters

Responses

Response samples

/categories/{id}

Authorizations:

header Parameters

Responses

Response samples

Fetch a paginated list of products for a category

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Fetch a paginated list of bundles for a category

Authorizations:

query Parameters

header Parameters

Responses

Response samples

product

Create a product

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a paginated list of products

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Find a product

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Update a product

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Delete a product

Authorizations:

header Parameters

Responses

Response samples

bundle

Create a bundle

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Fetch a paginated list of bundles

Authorizations:

query Parameters

header Parameters

Responses

Response samples

Find a bundle

Authorizations:

query Parameters

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required