Fees
Fees are set based on the ship or pickup country, province, state, or zip code of an order. Fees are similar to Taxes, but output in a separate array. They have any applicable taxes calculated on top of the Fee amount, while Taxes cannot have tax applied on top of the amount. Fees are sent to ShipCompliant as a product.
Fees were introduced Oct 23, 2026.
Fee object
{
"id": "cb898b94-d6ca-4c31-aa20-4a8986714743",
"title": "Custom Canada Fee",
"countryCode": "CA",
"zipCodes": [
"V3M0E8"
],
"freight": 5,
"food": 5,
"generalMerchandise": 5,
"wine": 5,
"book": 5,
"preparedFood": 5,
"isFlatRate": false,
"createdAt": "2026-08-26T20:57:18.041Z",
"updatedAt": "2026-09-16T21:53:05.259Z",
"stateCode": "BC",
"isFreightTaxIncludedInPrice": true,
"isFoodTaxIncludedInPrice": true,
"isGeneralMerchandiseTaxIncludedInPrice": false,
"isWineTaxIncludedInPrice": false,
"isBookTaxIncludedInPrice": false,
"isPreparedFoodTaxIncludedInPrice": false
}Retrieve fee
GET /v2/custom-fee/{:customFeeId}
Response
custom fee object
Delete fee
DELETE /v2/custom-fee/{:customFeeId}
Response
custom fee object with 204 status
List fees
GET /v2/custom-fee
Response
An array of custom fee objects and total count
{
customFees: [
{
id: "690b8c8e-f86b-4918-92d4-5029bdead5c2",
customFeeId: "916c226f-d0a1-4394-81fe-d255cf61c07c",
title: "CRV",
countryCode: "US",
stateCode: "CA",
zipCode: "94558",
freight: 0,
food: 0,
generalMerchandise: 0,
wine: 10,
book: 0,
preparedFood: 0,
price: 10,
originalPrice: 10,
isPriceOverride: false,
isIncludedInPrice: false,
isFlatRate: true,
sortOrder: 0,
code: "crv",
},
],
"total": 1
}Order Payload
GET /v2/order/:orderId
{
"id": "8706ae1c-31f4-4bd5-9e13-d8aaf736f9a3",
"orderSubmittedDate": "2026-09-16T22:43:45.884Z",
"orderPaidDate": "2026-09-16T22:43:45.884Z",
"orderFulfilledDate": null,
"orderNumber": 1703,
"orderSource": "Internal",
"customerType": "Repeat Customer",
"purchaseType": "Regular",
"previousOrderId": null,
"previousOrderNumber": null,
"linkedOrders": [],
"paymentStatus": "Paid",
"complianceStatus": "Forced",
"fraudCheckStatus": "Not Checked",
"fulfillmentStatus": "Not Fulfilled",
"shippingStatus": "Not Tracked",
"cartId": "8706ae1c-31f4-4bd5-9e13-d8aaf736f9a3",
"channel": "Inbound",
"salesAttributeCode": "Inbound",
"posProfileId": null,
"customerId": "13fad46a-5719-4b84-b70f-3fd14588be6b",
"orderDeliveryMethod": "Ship",
"shippingInstructions": null,
"taxSaleType": "Offsite",
"subTotal": 10000,
"shipTotal": 100,
"taxTotal": 0,
"dutyTotal": 0,
"customFeeTotal": 500,
"bottleDepositTotal": 500,
"tipTotal": 0,
"discountTotal": 0,
"total": 11100,
"totalAfterTip": 11100,
"giftMessage": null,
"metaData": null,
"appData": null,
"appSync": null,
"flags": [],
"isNonTaxable": false,
"isNoDuty": false,
"loyaltyPointsEarned": 500,
"createdAt": "2026-09-16T17:21:35.910Z",
"updatedAt": "2026-09-16T22:43:47.035Z",
"additionalData": null,
"customer": {
"id": "13fad46a-5719-4b84-b70f-3fd14588be6b",
"avatar": null,
"honorific": null,
"firstName": "Peter",
"lastName": "Hua",
"birthDate": null,
"city": "New Westminster",
"stateCode": "BC",
"zipCode": "V3M0E8",
"countryCode": "CA",
"emailMarketingStatus": null,
"metaData": null,
"appData": null,
"appSync": null,
"productJSON": [
{
"product": {
"sku": "2015Rose",
"image": "https://images.commerce7.com/images/noimages/original/no-image.png",
"price": 10000,
"title": "2015Rose",
"quantity": 1,
"productId": "9b8f81e3-d8e0-4d70-9995-d2a4998040ae",
"wineProperties": {
"type": "Rose",
"region": "Ontario",
"vintage": 2016,
"varietal": "Rose",
"varietals": [],
"appellation": "Niagara Peninsula",
"countryCode": "CA",
"tasteProfile": {
"body": 5,
"tannin": 3,
"acidity": 3,
"sweetness": 3,
"fruitiness": 4
}
}
},
"purchaseDate": "2026-09-16T22:43:45.884Z"
},
{
"product": {
"sku": "paid-tour",
"image": "https://images.commerce7.com/images/noimages/original/no-image.png",
"price": 500,
"title": "Paid tour",
"quantity": 2,
"productId": "22f4fb47-528e-4cb3-bb10-86a39299433b"
},
"purchaseDate": "2024-12-11T21:24:25.155Z"
}
],
"flags": [],
"notifications": [],
"createdAt": "2024-12-11T21:24:23.987Z",
"updatedAt": "2026-09-16T22:43:47.034Z",
"orderInformation": {
"currentWebCartId": null,
"lastOrderId": "8706ae1c-31f4-4bd5-9e13-d8aaf736f9a3",
"lastOrderDate": "2026-09-16T22:43:45.884Z",
"orderCount": 2,
"lifetimeValue": 12100,
"lifetimeValueSeedAmount": 0,
"yearlyValue": {
"2024": 1000,
"2026": 11100
},
"yearlyOrderCount": {
"2024": 1,
"2026": 1
},
"yearlyVisitCount": {},
"grossProfit": -1000,
"acquisitionChannel": "Web",
"currentClubTitle": null,
"daysInCurrentClub": null,
"daysInClub": null,
"isActiveClubMember": false
},
"loyalty": {
"tier": "Base Tier",
"loyaltyTierId": "bd07cd76-9e33-42b8-9815-ba3a6f5ffdde",
"points": 520
},
"emails": [
{
"id": "7f7c0b2f-4101-479b-83a3-f0abf64d1e57",
"email": "[email protected]",
"status": "Ok"
}
],
"phones": [
{
"id": "a6217d17-ffb7-4edc-b7fa-d71491062195",
"phone": "+12345670101"
}
],
"clubs": [],
"hasAccount": false,
"loginActivity": {
"lastLoginAt": null,
"loginIP": null,
"lastLogoutAt": null
},
"signupPrediction": {
"score": null,
"tier": null,
"lastCalculatedDate": null
}
},
"club": null,
"reservation": null,
"corporate": null,
"shipping": [
{
"id": "328b22a4-ea47-4cd5-81a2-8a87c81d7f47",
"vendor": "Local",
"title": "Ground",
"code": "FEDEX",
"carrier": "FedEx",
"service": "3 Day",
"shippingServiceId": "a1ee9ace-3cd2-477a-93ee-55645d30e248",
"appId": null,
"price": 100,
"originalPrice": 100,
"isPriceOverride": false,
"processorResponse": null,
"tax": 0,
"customFee": 5
}
],
"coupons": [],
"shipTo": {
"id": "796f4b13-0af4-4792-a9ed-3ce1f6b186ef",
"customerAddressId": "f09c806b-e60c-4fb4-9c27-b64b6f26f043",
"birthDate": "1960-01-01",
"honorific": "Mr",
"firstName": "Peter",
"lastName": "Hua",
"company": null,
"phone": "+12365163191",
"address": "218 Brookes St",
"address2": null,
"city": "New Westminster",
"stateCode": "BC",
"zipCode": "V3M0E8",
"countryCode": "CA"
},
"billTo": null,
"pickupBy": null,
"carrierPickupLocation": null,
"carryOut": null,
"promotions": [],
"tenders": [
{
"id": "81342280-3c30-4009-a337-ee4a7bc9830a",
"originalOrderTenderId": null,
"tenderType": "Credit Card",
"chargeType": "Sale",
"chargeStatus": "Success",
"amountTendered": 11100,
"tip": 0,
"errorCode": "",
"paymentDate": "2026-09-16T22:43:45.719Z",
"otherPaymentMethod": null,
"notes": null,
"createdAt": "2026-09-16T17:21:58.341Z",
"updatedAt": "2026-09-16T22:43:45.920Z",
"creditCard": {
"gateway": "No Gateway",
"cardBrand": "MasterCard",
"digitalWalletType": null,
"maskedCardNumber": "************5454",
"bin": null,
"expiryMo": 11,
"expiryYr": 2025,
"cardHolderName": null,
"oneTimeToken": null,
"tokenOnFile": "fakeId",
"processorResponse": null,
"authorizationId": null,
"customerCreditCardId": "9452383e-9b4a-4cbb-b9e5-d45002d18913"
}
}
],
"fulfillments": [],
"taxes": [
{
"id": "0339c039-7d42-41ea-b3e3-4f6c1c1f06f1",
"vendor": "Local",
"title": "GST",
"countryCode": "CA",
"stateCode": null,
"freight": 0,
"food": 0,
"generalMerchandise": 10,
"wine": 0,
"book": 0,
"preparedFood": 0,
"price": 0,
"originalPrice": 0,
"isPriceOverride": false,
"isIncludedInPrice": false,
"isFlatRate": false,
"isNonTaxable": false,
"sortOrder": 0,
"code": null
},
{
"id": "8355e399-e8e6-4ae3-a8f6-0cd1431e52ca",
"vendor": "Local",
"title": "GST",
"countryCode": "CA",
"stateCode": null,
"freight": 0,
"food": 0,
"generalMerchandise": 0,
"wine": 10,
"book": 0,
"preparedFood": 0,
"price": 954,
"originalPrice": 954,
"isPriceOverride": false,
"isIncludedInPrice": true,
"isFlatRate": false,
"isNonTaxable": false,
"sortOrder": 0,
"code": null
}
],
"duties": [],
"customFees": [
{
"id": "6a5cb2f2-37e4-469b-a471-25558ab0191e",
"customFeeId": "cb898b94-d6ca-4c31-aa20-4a8986714743",
"title": "Custom Canada Fee",
"countryCode": "CA",
"stateCode": "BC",
"zipCode": "V3M0E8",
"freight": 0,
"food": 0,
"generalMerchandise": 5,
"wine": 5,
"book": 5,
"preparedFood": 5,
"price": 500,
"originalPrice": 500,
"isPriceOverride": false,
"isIncludedInPrice": false,
"isFlatRate": false,
"sortOrder": 0
},
{
"id": "71533878-05c0-4234-81e5-987617b222a9",
"customFeeId": "cb898b94-d6ca-4c31-aa20-4a8986714743",
"title": "Custom Canada Fee",
"countryCode": "CA",
"stateCode": "BC",
"zipCode": "V3M0E8",
"freight": 5,
"food": 5,
"generalMerchandise": 0,
"wine": 0,
"book": 0,
"preparedFood": 0,
"price": 5,
"originalPrice": 5,
"isPriceOverride": false,
"isIncludedInPrice": true,
"isFlatRate": false,
"sortOrder": 0
}
],
"posProfile": null,
"items": [
{
"id": "dfc26e40-5983-49ea-ac8f-a1c649054dbf",
"linkedItemId": null,
"purchaseType": "Regular",
"productTitle": "2015Rose",
"productSlug": "2016-rose",
"type": "Wine",
"inventoryLocationId": null,
"productId": "9b8f81e3-d8e0-4d70-9995-d2a4998040ae",
"productVariantTitle": "750ml",
"productVariantId": "fa8ff30d-d88e-4fe4-ad43-bc54c28b3c89",
"image": "https://images.commerce7.com/images/noimages/original/no-image.png",
"sku": "2015Rose",
"costOfGood": 11000,
"price": 10000,
"originalPrice": 10000,
"comparePrice": 15000,
"bottleDeposit": 500,
"quantity": 1,
"quantityFulfilled": 0,
"quantitySentToPrep": 0,
"isPriceOverride": false,
"tax": 909,
"customFee": 500,
"taxType": "Wine",
"weight": 1,
"hasShipping": true,
"vendor": null,
"volumeInML": 750,
"alcoholPercentage": 1,
"departmentCode": "Wine",
"allocationId": null,
"departmentId": "123145d0-48c7-41f4-a808-2ae04c226169",
"collectionIds": "cc00a662-35bb-4f57-9264-20428aebf557",
"bundleItems": null,
"itemData": {},
"modifiers": null,
"notes": null
}
],
"selectedShippingOptions": {
"shippingServiceId": null,
"shippingTitleFromApp": null
},
"connectionInformation": {
"customerIpAddress": "::ffff:127.0.0.1",
"userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/152.0.0.0 Safari/537.36"
},
"fraud": {
"isFraudulent": false,
"comment": null
},
"salesAssociate": {
"accountId": "cd37be52-59fc-4b7d-9003-2f38a7259ddf",
"name": "Peter Hua"
},
"tags": [
{
"id": "5212fef8-31b3-4c47-90fc-4cab230ba11c",
"title": "channel tag",
"objectType": "Order",
"type": "Dynamic",
"appliesToCondition": "One or more conditions",
"createdAt": "2025-01-16T19:33:11.948Z",
"updatedAt": "2025-01-17T01:03:29.112Z",
"backPopulate": {
"currentPage": 9,
"totalPages": 9,
"cursor": "eb74da5a-ea84-453c-b021-f6e6077f5d20",
"status": "Completed",
"processDate": "2025-01-17T01:03:29.111Z"
}
},
{
"id": "a76facfd-3d71-4734-8d3b-c9e950bf5b44",
"title": "channel tag",
"objectType": "Order",
"type": "Dynamic",
"appliesToCondition": "One or more conditions",
"createdAt": "2025-01-16T19:34:50.855Z",
"updatedAt": "2025-01-16T19:34:52.098Z",
"backPopulate": {
"currentPage": 9,
"totalPages": 9,
"cursor": "eb74da5a-ea84-453c-b021-f6e6077f5d20",
"status": "Completed",
"processDate": "2025-01-16T19:34:52.098Z"
}
}
]
}
Updated about 9 hours ago
Did this page help you?