Breaking Changes from Beta

The following represents breaking changes when moving from the /beta end points to the /v1 end points.

Meta Data

Meta Data on Products, Orders, Customers, Reservations, Carts, Customer Addresses is no longer an array but is now an object.

{
 "id": "91b4a9d1-2b0f-442d-a5b8-126ea50a1b18",
 "avatar": "http://graph.facebook.com/10156101208888136/picture?type=large",
 "firstName": "Andrew",
 "lastName": "Kamphuis",
 "birthDate": "1973-11-15",
 "city": "Vancouver",
 "stateCode": "BC",
 "zipCode": "V6A 1C2", 
 "countryCode": "CA",
 "emailMarketingStatus": "Subscribed",
 "lastActivityDate": "2018-05-11T15:35:45.123Z",
 "facebookId": "10156101208888136",
 "metaData": {
  "spouses-name": "Julia",
  "source": "Referal from Friend"
 },
 "createdAt": "2018-02-20T02:23:56.571Z",
 "updatedAt": "2018-05-14T18:09:17.445Z",
 "emails": [{
  "id": "e4a0342f-61c5-41e6-ab7c-86df4b6cb14e",
  "email": "[email protected]"
 }, {
  "id": "f03e2191-ebf0-4f9d-bfba-1959c6f376c9",
  "email": "[email protected]"
 }],
 "phones": [{
  "id": "b08aaf2d-734c-4b7f-9cff-7500b0096532",
  "phone": "+16046135343"
 }],
 "groups": [],
 "orderInformation": {
  "lastOrderId": "e5a694e0-3c01-43cd-8ef9-224b907214f0",
  "lastOrderDate": "2018-05-11T15:35:43.952Z",
  "orderCount": 65,
  "lifetimeValue": 590709,
  "currentClubTitle": "Spectra Club",
  "daysInCurrentClub": 28
 },
 "clubs": [{
  "clubId": "655eb7c3-ab0f-4c3f-997c-a77f1c5c4a2c",
  "clubTitle": "Spectra Club",
  "cancelDate": null,
  "signupDate": "2018-04-22T02:10:34.832Z",
  "clubMembershipId": "fefecc61-ef68-499b-8c1e-ee59e20b0053"
 }]

Customers

GroupIds no longer exists on the customer object. Instead we have groups which is an array of the group object. When creating a customer you can pass in an array of group objects (with just the groupId) to create a customer with groups.

{
 "id": "91b4a9d1-2b0f-442d-a5b8-126ea50a1b18",
 "avatar": "http://graph.facebook.com/10156101208888136/picture?type=large",
 "firstName": "Andrew",
 "lastName": "Kamphuis",
 "birthDate": "1973-11-15",
 "city": "Vancouver",
 "stateCode": "BC",
 "zipCode": "V6A 1C2", 
 "countryCode": "CA",
 "emailMarketingStatus": "Subscribed",
 "lastActivityDate": "2018-05-11T15:35:45.123Z",
 "facebookId": "10156101208888136",
 "metaData": [{
  "id": "9453c834-be80-4909-86f5-48f041e0076a",
  "code": "spouses-name",
  "value": "Julia"
 }, {
  "id": "db8d18c0-27c1-49e1-af84-cf9941450c3b",
  "code": "source",
  "value": "Referal from Friend"
 }],
 "createdAt": "2018-02-20T02:23:56.571Z",
 "updatedAt": "2018-05-14T18:09:17.445Z",
 "emails": [{
  "id": "e4a0342f-61c5-41e6-ab7c-86df4b6cb14e",
  "email": "[email protected]"
 }, {
  "id": "f03e2191-ebf0-4f9d-bfba-1959c6f376c9",
  "email": "[email protected]"
 }],
 "phones": [{
  "id": "b08aaf2d-734c-4b7f-9cff-7500b0096532",
  "phone": "+16046135343"
 }],
 "groups": [{
  "id": "588d36ef-c202-4731-aa97-7e7d4ebc66e6",
  "title": "My First Group",
  "type": "Manual",
  "createdAt": "2019-06-27T13:18:18.311Z",
  "updatedAt": "2019-06-27T13:18:18.311Z"
 }],
 "orderInformation": {
  "lastOrderId": "e5a694e0-3c01-43cd-8ef9-224b907214f0",
  "lastOrderDate": "2018-05-11T15:35:43.952Z",
  "orderCount": 65,
  "lifetimeValue": 590709,
  "currentClubTitle": "Spectra Club",
  "daysInCurrentClub": 28
 },
 "clubs": [{
  "clubId": "655eb7c3-ab0f-4c3f-997c-a77f1c5c4a2c",
  "clubTitle": "Spectra Club",
  "cancelDate": null,
  "signupDate": "2018-04-22T02:10:34.832Z",
  "clubMembershipId": "fefecc61-ef68-499b-8c1e-ee59e20b0053"
 }]

Products

CollectionIds no longer exists on the product object. Instead we have collections which is an array of the collection object. When creating a product you can pass in an array of collection objects (with just the collectionId) to create a product with collections.

{
"id": "454a8ba7-8685-4f1b-a1f3-07f44a9668be",
"title": "2012 Spectra Cabernet Sauvignon",
"subTitle": null,
"image": "https://images.commerce7.com/spectrawinery/images/original/spectra-red-1522094480333.png",
"type": "Wine",
"departmentId": "ff78df8d-f7db-429a-9271-42e79aace894",
"vendorId": "5aa5526f-dea6-43ac-ac0d-89706f470ef2",
"teaser": "A dense, mid-palate richness, complexity and a delicious finish. Dark red cherry fruit and sinfully deep mocha flavors that finish with a spicy note of black pepper.",
"content": "Wine Profile\n    Tasting Notes\n    This wine has everything we love about Oakville cabernet sauvignon: a dense, mid-palate richness, complexity and a delicious finish. Dark red cherry fruit and sinfully deep mocha flavors that finish with a spicy note of black pepper. 76% Cabernet Sauvignon, 13% Cabernet Franc, 4% Malbec, 4% Petit Verdot, 3% Merlot\n\n    Vineyard Notes\n    The low fertility, well-drained soils and optimal sun exposure yield rich, complex flavors and impeccable fruit maturity.\n\n    Winemaker Notes\n    The grapes were hand-harvested into small bins and carefully sorted in our gravity-flow cellar. The clusters were destemmed directly into traditional French oak tanks for cold soak, fermentation and extended maceration – a total of 33 days of wine to skin contact – maximizing the extraction of varietal character and complexity while keeping the tannins fleshy and supple. The new wine was drained and gently pressed into 78% new French-oak barrels for malolactic fermentation, assuring seamless integration of fruit and oak. The final blend was assembled through repeated tasting trials over the 20 months of barrel aging. The wine was bottled in July of 2014.",
"publishDate": "2018-03-20T02:01:00.000Z",
"slug": "2012-cabernet-sauvignon-oakville-napa-valley",
"metaData": {
 "badge": "Award Winning"
},
"productTemplateId": null,
"createdAt": "2018-03-26T19:01:37.658Z",
"updatedAt": "2018-11-28T16:32:42.045Z",
"images": [{
 "id": "20395018-952b-4ee3-b12f-b9693e522838",
 "src": "https://images.commerce7.com/spectrawinery/images/original/spectra-red-1522094480333.png",
 "sortOrder": 0
}, {
 "id": "a656f236-a845-4ea0-a2ee-111a9930ae9c",
 "src": "https://images.commerce7.com/spectrawinery/images/original/red-wine-bottle-vector-1526579591169.jpg",
 "sortOrder": 1
}],
"variants": [{
 "id": "a697bf51-4189-4bad-8fe2-c2d73183d9f5",
 "title": "750ml",
 "sku": "2012-CS15",
 "upcCode": null,
 "volumeInML": 750,
 "costOfGood": 1500,
 "price": 4500,
 "comparePrice": 4500,
 "bottleDeposit": 0,
 "sortOrder": 2,
 "hasInventory": false,
 "inventoryPolicy": "Back Order",
 "hasShipping": true,
 "taxType": "Wine",
 "weight": 3,
 "inventory": null
}],
"collections": [{
 "id": "cad158a7-7c4d-4229-8f5a-b7c146edd533",
 "title": "Collectors' List",
 "content": "<p>Rare collectible wines&nbsp;</p>",
 "publishDate": "2019-05-13T21:24:00.000Z",
 "slug": "collectors'-list",
 "productTemplateId": null,
 "type": "Manual",
 "productCount": null,
 "appliesToCondition": null,
 "onlyShowProductsWithInventory": false,
 "createdAt": "2019-05-13T21:24:40.361Z",
 "updatedAt": "2019-05-13T23:18:13.190Z",
 "conditions": [],
 "seo": {
  "title": "Collectors' List",
  "description": "Rare collectible wines"
  }
 }, {
 "id": "4e912d95-8b28-42e0-9df1-f26d2ef2db5c",
 "title": "Current Releases",
 "content": "",
 "publishDate": "2018-07-10T12:02:00.000Z",
 "slug": "current-releases",
 "productTemplateId": null,
 "type": "Manual",
 "productCount": null,
 "appliesToCondition": null,
 "onlyShowProductsWithInventory": false,
 "createdAt": "2018-07-10T12:02:25.201Z",
 "updatedAt": "2019-05-13T23:23:18.038Z",
 "conditions": [],
 "seo": {
  "title": "Current Releases",
  "description": null
 }
}],
"seo": {
 "title": "2012 Spectra Cabernet Sauvignon",
 "description": null
},
"wine": {
 "type": "Red",
 "varietal": "Cabernet Sauvignon",
 "countryCode": "US",
 "region": "California",
 "appellation": "Oakville",
 "vintage": 2012
},
"security": {
 "availableTo": "Public"
},
"overrideOperatingRegions": {
 "isOverride": false,
 "operatingStateCodes": null,
 "operatingCountryCodes": null
}
}

Coupons and Promotions

PromotionSetIds no longer exists on the coupon or promotion object. Instead we have promotionSets which is an array of the promotionSet object. When creating a coupon or promotion you can pass in an array of promotionSet objects (with just the promotionSetId) to create a coupon or promotion with a promotion set.

{
 "id": "8ac801c3-8bf9-4bd3-a65c-cd05dbdbaf15",
 "title": "$10 Off",
 "actionMessage": null,
 "usageLimitType": "Unlimited",
 "usageLimit": null,
 "appliesTo": "Store",
 "appliesToObjectIds": null,
 "productDiscountType": "Dollar Off",
 "productDiscount": 10,
 "shippingDiscountType": "No Discount",
 "shippingDiscount": null,
 "startDate": "2018-05-18T04:10:38.857Z",
 "endDate": null,
 "status": "Enabled",
 "minimumCartAmount": null,
 "availableTo": "Everyone",
 "availableToObjectIds": null,
 "createdAt": "2018-05-18T16:53:46.166Z",
 "updatedAt": "2018-05-18T16:53:46.166Z",
 "promotionSets": []
}

Other Breaking Changes

  • Feature Image gone from Collections
  • The enum of "No Compliance" has been changed to "Not Checked"