Exploring the Data
In this video we’ll explore:
1. What data is available through the Itembase iPaaS?
2. How do I receive the Data in my Application?
3. How can I write Data back into the Commerce System?
4. What period of time is data available from?
Read – Normalized Data Sets: Examples
Standard Normalized Payloads
Excel Version with sample data.
JSON Version with sample data
Order Entity
{
"acceptedOffer": [
{
"availabilityEnds": null,
"availabilityStarts": null,
"deliveryLeadTime": null,
"depth": {
"unitCode": null,
"unitText": null,
"value": null
},
"description": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"height": {
"unitCode": null,
"unitText": null,
"value": null
},
"identifier": "525529",
"image": "http://imageurl.com/images/products/L19297235.jpg",
"inventoryLevel": {
"unitCode": null,
"unitText": null,
"value": "0"
},
"category": null,
"name": "Commercial Bed Bug Kit",
"sku": "1-4649-1",
"url": "",
"quantity": 1,
"price": {
"value": 331.83,
"currency": null
},
"weight": {
"unitCode": null,
"unitText": null,
"value": null
},
"width": {
"unitCode": null,
"unitText": null,
"value": null
},
"offerDelivery": {
"deliveryAddress": {
"addressCountry": "US",
"addressLocality": "Stevens",
"addressRegion": "PA",
"postalCode": "17578",
"streetAddress": "45 Main Street",
"receiver": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"trackingNumber": null,
"parcelService": null,
"recipient": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"offerDeliveryTotal": {
"price": {
"value": 0.0,
"currency": null
},
"taxesIncluded": false,
"taxes": {
"taxRate": null,
"taxType": null,
"taxValue": {
"value": 0.0,
"currency": null
}
}
},
"createdAt": "2016-08-23T16:38:32.85",
"updatedAt": "2016-10-04T00:18:20.7433333"
},
{
"availabilityEnds": null,
"availabilityStarts": null,
"deliveryLeadTime": null,
"depth": null,
"description": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"gtin8": null,
"height": null,
"identifier": "525530",
"image": null,
"inventoryLevel": null,
"category": null,
"name": "BORACARE (Pack of 4)",
"sku": "4-100-2",
"url": "",
"quantity": 2,
"price": {
"value": 466.67,
"currency": null
},
"weight": null,
"width": null,
"offerDelivery": {
"deliveryAddress": {
"addressCountry": "US",
"addressLocality": "Stevens",
"addressRegion": "PA",
"postalCode": "17578",
"streetAddress": "45 Main Street",
"receiver": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"trackingNumber": null,
"parcelService": null,
"recipient": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"offerDeliveryTotal": {
"price": {
"value": 0.0,
"currency": null
},
"taxesIncluded": false,
"taxes": {
"taxRate": null,
"taxType": null,
"taxValue": {
"value": 0.0,
"currency": null
}
}
},
"createdAt": null,
"updatedAt": null
}
],
"identifier": "25273704",
"discount": "0.0",
"discountCode": null,
"orderNumber": null,
"orderStatus": "Cleared",
"paymentMethod": "Jet",
"paymentMethodId": null,
"paymentLast4Digits": "",
"customer": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": "jonathan.doe.jet.447094560291@example.com",
"telephone": "1234567890"
},
"billingAddress": {
"addressCountry": "US",
"addressLocality": "Stevens",
"addressRegion": "PA",
"postalCode": "17578",
"streetAddress": "45 Main Street",
"receiver": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"orderDelivery": {
"deliveryAddress": {
"addressCountry": "US",
"addressLocality": "Stevens",
"addressRegion": "PA",
"postalCode": "17578",
"streetAddress": "45 Main Street",
"receiver": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"trackingNumber": null,
"parcelService": null,
"recipient": {
"email": "jonathan.doe.jet.447094560291@example.com",
"familyName": "Doe",
"givenName": "Jonathan",
"additionalName": null,
"identifier": null,
"telephone": "1234567890"
}
},
"orderDeliveryTotal": {
"price": {
"value": null,
"currency": null
},
"taxesIncluded": false,
"taxes": {
"taxRate": null,
"taxType": null,
"taxValue": {
"value": null,
"currency": null
}
}
},
"orderTotal": {
"price": {
"value": 1699.99,
"currency": null
},
"taxesIncluded": true,
"taxes": {
"taxRate": null,
"taxType": null,
"taxValue": {
"value": 0.0,
"currency": null
}
}
},
"orderDate": "2016-09-25T23:47:03",
"createdAt": "2016-09-26T03:42:30.947",
"updatedAt": null
}Product Entity
{
"brand": {
"name": null
},
"category": null,
"createdAt": "2016-08-23T16:38:32.85",
"updatedAt": "2016-10-04T00:18:20.7433333",
"identifier": "2152403",
"name": "",
"description": null,
"sku": "roUne2fZMqU7dl6eX8ITZQ",
"gtin8": null,
"gtin12": null,
"gtin13": null,
"gtin14": null,
"image": "http://imageurl.com/images/products/L19297235.jpg",
"url": null,
"isVariant": true,
"offers": null,
"price": {
"value": null,
"currency": null
},
"weight": {
"unitCode": null,
"unitText": null,
"value": null
},
"width": {
"unitCode": null,
"unitText": null,
"value": null
},
"depth": {
"unitCode": null,
"unitText": null,
"value": null
},
"height": {
"unitCode": null,
"unitText": null,
"value": null
},
"inventoryLevel": {
"unitCode": null,
"unitText": null,
"value": "0"
}
}Store Entity
{
"address": {
"addressCountry": "US",
"addressLocality": "Morrisville",
"addressRegion": "NC",
"postalCode": "27560",
"streetAddress": "3025 Carrington Mill Blvd",
"receiver": null
},
"currenciesAccepted": [
"USD"
],
"paymentsAccepted": null,
"email": "Jones",
"identifier": "12345678",
"name": "ChannelAdvisor Sample Accounts",
"telephone": "919-123-4567",
"url": null,
"locale": null,
"createdAt": null,
"updatedAt": null
}Custom Normalized Payloads
The Itembase iPaaS acts as a Proxy, so you will be able to access ALL the data that the Commerce System allows. You can either access it through the NAtive API on the fly or add a custom normalized data payload during setup, which will allow you to let us automate your flows.
Write – Normalized Data Sets: Examples
Example Standard Normalized Payloads
Normalized Data Payload: Shipping Tracking: SWAGGER example
https://api.itembase.com/specs/writeback-webservice#/Normalized%20Writeback–
Normalized Data Payload: Order Status Update:
openapi: "3.0.2"
info:
title: Writeback Webservice Order Status
version: 1.0.0
description: Provides the functionality of updating order status for a given order on a specific commerce system
paths:
/connectivity/instances/{instanceId}/normalized-writeback/connections/{connectionId}/order-status:
post:
tags: [Normalized Writeback Order Status]
summary: Updates for a given order the order status
parameters:
- in: path
name: instanceId
schema:
type: string
format: uuid
required: true
description: Instance UUID of the connector for the specific Commerce System
- in: path
name: connectionId
schema:
type: string
format: uuid
required: true
description: Connection UUID of the connected store for which API call should be applied
requestBody:
required: true
description: The orderId is the commerce-system specific order id for which order status needs to be updated. The status represents the order statu of the order that needs to be update.
content:
application/json:
schema:
type: object
properties:
orderId:
type: string
status:
type: string
responses:
'2XX':
description: Response code depends on commerce system API
'4XX':
description: Response code depends on commerce system API
'5XX':
description: Response code depends on commerce system APINormalized Data Payload: Inventory Update:
openapi: "3.0.2"
info:
title: Writeback Webservice Product Inventory Quantity
version: 1.0.0
description: Provides the functionality of updating product inventory quantity for a given product on a specific commerce system
paths:
/connectivity/instances/{instanceId}/normalized-writeback/connections/{connectionId}/product-inventory/quantity:
post:
tags: [Normalized Writeback Product Inventory Quantity]
summary: Updates for a given product the product inventory quantity
parameters:
- in: path
name: instanceId
schema:
type: string
format: uuid
required: true
description: Instance UUID of the connector for the specific Commerce System
- in: path
name: connectionId
schema:
type: string
format: uuid
required: true
description: Connection UUID of the connected store for which API call should be applied
requestBody:
required: true
description: The productId is the commerce-system specific product id for which product inventory quantity needs to be updated. The product qnt represents the new inventory that should be set for this specific product
content:
application/json:
schema:
type: object
properties:
productId:
type: string
qnt:
type: string
responses:
'2XX':
description: Response code depends on commerce system API
'4XX':
description: Response code depends on commerce system API
'5XX':
description: Response code depends on commerce system APICustom Normalized Payloads
See above regarding custom write payloads.
Native API Access
The Itembase iPaaS Native API acts as a Proxy and allows you query any data available from the Commerce System at any time. This gives you maximum flexibility to develop new features or customize a solution for 1 merchant.
Historic Data Import
You can access historic data from the Commerce System through a Historic Import. You can define whether you want a Historic Import to trigger upon connection by a merchant, on a recurring basis or upon request.