Item Fee management
Retrieve all itemFees.
the tenant to work on.
testtenant
A list of site codes.
main
A list of feeIds.
A list of product Ids.
Whether only the fee-id is in the response or the full fees.
false
The page number to be retrieved where the size of the pages must be specified by the pageSize parameter. The number of the first page is 1.
1
The number of documents being retrieved on one page.
16
false
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
*
Request was successful.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
Some server-side error occurred. Details will be provided in the response payload.
GET /fee/{tenant}/itemFees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "5d94b80beec29eba2ad2793e",
"feeIds": [
"5d94b7e8eec29eba2ad2793d"
],
"itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5d934ed1eec29e0f8706b381",
"siteCode": "main",
"fees": [
{
"name": "Pear Fee",
"code": "pear_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 2.5,
"currency": "EUR"
},
"active": true,
"taxable": false
},
{
"name": "Plum Fee",
"code": "plum_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 2.99,
"currency": "EUR"
},
"active": true,
"taxable": false
}
]
},
{
"id": "5d94b674eec29eba2ad2793a",
"feeIds": [
"5d94b5ffeec29eba2ad27938",
"5d94b610eec29eba2ad27939"
],
"fees": [
{
"name": "Apple Picking Fee",
"code": "apple_picking_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"active": true,
"taxable": false
},
{
"name": "Apple Mackintosh Fee",
"code": "apple_mackintosh_fee",
"feeType": "ABSOLUTE",
"siteCode": "main",
"feeAbsolute": {
"amount": 4.5,
"currency": "EUR"
},
"active": true,
"taxable": false
}
],
"itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
"siteCode": "main"
}
]
the tenant to work on.
testtenant
The locale identifier of the language of the updated attribute.
Unique identifier of the item fee.
The SiteCode this fee belongs to.
YRN of the item to assign fees to.
List of unique identifiers of fees to assign to the item.
The resource has been successfully created.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
Creation failed because there was a conflict with another resource. Any details will be provided within the response payload.
Some server-side error occurred. Details will be provided in the response payload.
POST /fee/{tenant}/itemFees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application:json
Accept: */*
Content-Length: 168
{
"siteCode": "main",
"itemYrn": "urn:yaas:saasag:caasproduct:product:tenantName;5c2e4957a46b0e0008491095",
"feeIds": [
"57b30fd2289c48001daf5486",
"96b30fd4586c48001daf1752"
]
}
{
"id": "5d80a196eec29e04726e921e",
"yrn": "urn:yaas:saasag:fee:id:tenantName;5d80a196eec29e04726e921e"
}
Retrieves all item fees for specified itemYRN.
the tenant to work on.
testtenant
A list of site codes.
main
Whether only the fee-id is in the response or the full fees.
false
The value of the locale identifier of the language in which the attribute should be returned. Provide several values separated by comma, in order to specify fallback languages.
*
["57b30fd2289c48001daf5486","96b30fd4586c48001daf1752"]
Request syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
GET /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
{
"id": "5d94587853b0c7036ab0ab7b",
"active": true,
"code": "lemon_picking_fee",
"feeAbsolute": {
"amount": 4.5,
"currency": "EUR"
},
"feeType": "ABSOLUTE",
"name": "Lemon Picking Fee",
"siteCode": "main",
"taxable": false,
"yrn": "urn:yaas:saasag:fee:id:tenantName;5d94587853b0c7036ab0ab7b"
},
{
"id": "5d94587853b0c7036ab0ab7b",
"active": true,
"code": "apple_picking_fee",
"feeAbsolute": {
"amount": 3.5,
"currency": "EUR"
},
"feeType": "ABSOLUTE",
"name": "Apple Picking Fee",
"siteCode": "main",
"taxable": false,
"yrn": "urn:yaas:saasag:fee:id:tenantName;5d9457d953b0c7036ab0ab7a"
}
]
the tenant to work on.
testtenant
Boolean parameter that defines the update type. By default, its value is false. For partial updates, the value is true.
false
FeeIds successfully added.
Request was syntactically incorrect. Any details will be provided within the response payload.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
PUT /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 66
{
"feeIds": [
"57b30fd2289c48001daf5486",
"96b30fd4586c48001daf1752"
]
}
No content
the tenant to work on.
testtenant
Item fee successfully deleted
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
DELETE /fee/{tenant}/itemFees/{itemYRN}/fees HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
the tenant to work on.
testtenant
Fee successfully deleted from itemYRN.
Given request is unauthorized - the authorization token is invalid or has expired.
Details will be provided in the response payload.
Access token does not contain necessary scopes or tenant in path does not match tenant from token.
The requested resource does not exist.
DELETE /fee/{tenant}/itemFees/{itemYRN}/fees/{feeId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
No content
Was this helpful?