Integration Overview
Salesforce Commerce Cloud empowers you to create seamless ecommerce experiences that inspire and convert today's connected shoppers. With our cloud-based ecommerce software, you can go to market faster and smarter — delivering personalized customer experiences across mobile, digital, and social platforms.
Salesforce Commerce Cloud (also known as Demandware) allows brands to build localized site, order management and fulfillment for each region in a single platform.
This integration is available for:
- Pro V1
- Pro V2
ERD
EXTRACTION OVERVIEW
Salesforce Commerce Cloud extraction is broken into two sections:
- Salesforce B2C Commerce (SFCC)
- Salesforce Order Management (SOM)
Salesforce B2C Commerce (SFCC) endpoints use the OpenCommerce API to extract data from the website.
Salesforce Order Management (SOM) endpoints use the
Postman cannot be used to extract sample data. Must work with Developer team to extract sample data due to connection requirements for all API Endpoints.
ENDPOINT: SFCC Campaigns
Campaign Resource API (/sites/{site_id}/campaigns/{campaign_id})
CAMPAIGNS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
campaign_id |
campaign_id |
VARCHAR |
description |
description |
VARCHAR |
enabled |
enabled |
BOOLEAN |
start_date |
start_date |
TIMESTAMP |
end_date |
end_date |
TIMESTAMP |
creation_date |
created_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
campaign_id + __shop_id |
CAMPAIGN CUSTOMER GROUPS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
campaign_id |
campaign_id |
VARCHAR |
customer_groups |
customer_group |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
campaign_id + customer_groups + __shop_id |
CAMPAIGN COUPON CODES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
campaign_id |
campaign_id |
VARCHAR |
coupons |
coupon_code |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
campaign_id + coupon_codes + __shop_id |
ENDPOINT: SFCC Catalogs
Catalog Resource API (/catalogs)
CATALOGS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
catalog_id |
VARCHAR |
creation_date |
created_at |
TIMESTAMP |
last_modified |
updated_at |
TIMESTAMP |
online |
online_status |
BOOLEAN |
name::default |
catalog_name |
VARCHAR |
assigned_product_count |
assigned_product_count |
INT |
category_count |
category_count |
INT |
owned_product_count |
owned_product_count |
INT |
recommendation_count |
recommendation_count |
INT |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
catalog_id + __shop_id |
CATALOG SITE TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
assigned_sites::id |
catalog_site_id |
VARCHAR |
id |
catalog_id |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
catalog_site_id + __shop_id |
ENDPOINT: SFCC Coupons
Coupon Resource API (/sites/{site_id}/coupons)
COUPONS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
coupon_id |
coupon_id |
VARCHAR |
creation_date |
created_at |
TIMESTAMP |
last_modified |
updated_at |
TIMESTAMP |
description |
description |
VARCHAR |
enabled |
coupon_enabled |
BOOLEAN |
single_code |
coupon_code |
VARCHAR |
total_codes_count |
total_coupon_codes |
INT |
type |
coupon_code_type |
VARCHAR |
redemption_limits:limit_per_code |
limit_per_code |
INT |
redemption_limits:limit_per_customer |
limit_per_customer |
INT |
system_codes_config:code_prefix |
coupon_code_prefix |
VARCHAR |
system_codes_config:number_of_codes |
max_coupon_codes |
INT |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
coupon_id + __shop_id |
ENDPOINT: SFCC Coupon Redemption Search
Coupon Redemption Search Resource API (/sites/{site_id}/coupon_redemption_search)
COUPON REDEMPTIONS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
coupon_id |
coupon_id |
VARCHAR |
coupon_code |
coupon_code |
VARCHAR |
customer_email |
customer_email |
VARCHAR |
order_no |
order_no |
VARCHAR |
creation_date |
created_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
coupon_id + order_no + __shop_id |
ENDPOINT: SFCC Inventory Lists
Inventory Lists Resource API (/inventory_lists)
INVENTORY LISTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
inventory_list_id |
VARCHAR |
creation_date |
created_at |
TIMESTAMP |
last_modified |
updated_at |
TIMESTAMP |
default_in_stock |
default_in_stock |
BOOLEAN |
on_order_inventory_enabled |
on_order_inventory_enabled |
BOOLEAN |
use_bundle_inventory_only |
use_bundle_inventory_only |
BOOLEAN |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
inventory_list_id + __shop_id |
INVENTORY LISTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id|| ':'||assigned_sites::[value] |
inventory_list_site_id |
VARCHAR |
id |
inventory_list_id |
VARCHAR |
assigned_sites::[value] |
site_name |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
inventory_list_id + site_name + __shop_id |
ENDPOINT: SFCC Products
Inventory Lists Resource API (/products/{id})
PRODUCTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
brand |
brand |
VARCHAR |
name::default |
product_name |
VARCHAR |
type::bundle |
product_is_bundle_flag |
BOOLEAN |
type::bundled |
product_part_of_bundle_flag |
BOOLEAN |
type::item |
product_item_flag |
BOOLEAN |
type::master |
product_master_flag |
BOOLEAN |
type::option |
product_option_flag |
BOOLEAN |
type::part_of_product_set |
part_of_product_set_flag |
BOOLEAN |
type::part_of_retail_set |
part_of_retail_set_flag |
BOOLEAN |
type::retail_set |
product_retail_set_flag |
BOOLEAN |
type::set |
product_set_flag |
BOOLEAN |
type::variant |
product_variant_flag |
BOOLEAN |
type::variation_group |
product_variation_group_flag |
BOOLEAN |
short_description::default::source |
short_description |
VARCHAR |
long_description::default::source |
long_description |
VARCHAR |
page_description::default |
page_description |
VARCHAR |
page_keywords::default |
page_keywords |
VARCHAR |
page_title::default |
page_title |
VARCHAR |
ats |
available_to_sell |
FLOAT |
default_variant_id |
default_variant_id |
VARCHAR |
ean |
ean |
VARCHAR |
in_stock |
in_stock |
BOOLEAN |
link |
product_url |
VARCHAR |
manufacturer_name |
manufacturer_name |
VARCHAR |
manufacturer_sku |
manufacturer_sku |
VARCHAR |
master::master_id |
product_master_id |
VARCHAR |
online_flag::default@[site_id] |
online_flag |
BOOLEAN |
owning_catalog_id |
owning_catalog_id |
VARCHAR |
owning_catalog_name |
owning_catalog_name |
VARCHAR |
price |
price |
FLOAT |
price_currency |
price_currency |
VARCHAR |
primary_category_id |
primary_category_id |
VARCHAR |
searchable |
searchable |
BOOLEAN |
unit |
unit |
VARCHAR |
upc |
upc |
VARCHAR |
creation_date |
created_at |
TIMESTAMP |
last_modified |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + __shop_id |
PRODUCT CATEGORIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
assigned_categories::catalog_id |
catalog_id |
VARCHAR |
assigned_categories::category_id |
category_id |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + catalog_id + __shop_id |
PRODUCT BUNDLES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
bundled_products::id |
bundled_product_id |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + bundled_product_id + __shop_id |
PRODUCT IMAGES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
image::alt::default |
alt_image_text |
VARCHAR |
image::dis_base_url |
product_image_url |
VARCHAR |
image::title::default |
image_title |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + image_title + __shop_id |
PRODUCT OPTIONS TABLE
Data Mapping
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
product_options::id |
product_option_id |
VARCHAR |
product_options::custom_name |
custom_name |
VARCHAR |
product_options::default_product_option_value |
default_option |
VARCHAR |
product_options::description::default |
description |
VARCHAR |
product_options::name |
product_option_name |
VARCHAR |
product_options::selected_option_value |
selected_option |
VARCHAR |
product_options::shared |
shared_product_option_flag |
BOOLEAN |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + product_option_id + __shop_id |
PRODUCT SETS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
product_sets::id |
component_product_id |
VARCHAR |
Business Rules.
Business Rule |
Value1 |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + component_product_id + __shop_id |
PRODUCT VARIANTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
variants::product_id |
product_variant_id |
VARCHAR |
variants::ats |
available_to_sell |
FLOAT |
variants::in_stock |
in_stock |
BOOLEAN |
variants::link |
product_variant_url |
VARCHAR |
variants::online |
online_flag |
BOOLEAN |
variants::orderable |
orderable_flag |
BOOLEAN |
variants::price |
price |
FLOAT |
variants::price_currency |
price_currency |
FLOAT |
variants::searchable::default@[site_id]1 |
searchable |
BOOLEAN |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + product_variant_id + __shop_id |
PRODUCT CUSTOM ATTRIBUTE VALUES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
product_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
product_id + custom_attribute_key + __shop_id |
ENDPOINT: SFCC Promotions
Inventory Lists Resource API (/sites/{site_id}/promotion_search)
PROMOTIONS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
promotion_id |
VARCHAR |
name::default |
promotion_name |
VARCHAR |
promotion_class |
promotion_class |
VARCHAR |
currency_code |
currency_code |
VARCHAR |
archived |
archived_flag |
BOOLEAN |
enabled |
enabled_flag |
BOOLEAN |
disable_globally_exclusion |
disable_global_exclusion_flag |
BOOLEAN |
exclusivity |
exclusivity |
VARCHAR |
assignment_information::campaign_id |
campaign_id |
VARCHAR |
assignment_information::schedule_type |
promotion_schedule_type |
VARCHAR |
assignment_information::end_date |
promotion_end_date |
TIMESTAMP |
creation_date |
created_at |
TIMESTAMP |
last_modified |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
promotion_id + __shop_id |
PROMOTION CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
promotion_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
promotion_id + custom_attribute_key + __shop_id |
PROMOTION TAGS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
promotion_id |
VARCHAR |
tags::tag_id |
tag_name |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
promotion_id + tag_name + __shop_id |
ENDPOINT: SFCC Sites
Inventory Lists Resource API (/sites)
PROMOTIONS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
site_id |
VARCHAR |
display_name::default |
site_name |
VARCHAR |
storefront_status |
site_status |
VARCHAR |
description |
description |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
site_id + __shop_id |
ENDPOINT: SOM Accounts
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_account.htm)
ACCOUNTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
account_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
MasterRecordId |
master_record_id |
VARCHAR |
Name |
name |
VARCHAR |
FirstName |
first_name |
VARCHAR |
LastName |
last_name |
VARCHAR |
Salutation |
salutation |
VARCHAR |
MiddleName |
middle_name |
VARCHAR |
Suffix |
suffix |
VARCHAR |
Type |
type |
VARCHAR |
RecordTypeId |
record_type_id |
VARCHAR |
ParentId |
parent_id |
VARCHAR |
BillingStreet |
billing_street |
VARCHAR |
BillingCity |
billing_city |
VARCHAR |
BillingState |
billing_state |
VARCHAR |
BillingStateCode |
billing_state_code |
VARCHAR |
BillingPostalCode |
billing_postal_code |
VARCHAR |
BillingCountry |
billing_country |
VARCHAR |
BillingCountryCode |
billing_country_code |
VARCHAR |
BillingGeocodeAccuracy |
billing_geocode_accuracy |
VARCHAR |
BillingLatitude |
billing_latitude |
FLOAT |
BillingLongitude |
billing_longitude |
FLOAT |
ShippingStreet |
shipping_street |
VARCHAR |
ShippingCity |
shipping_city |
VARCHAR |
ShippingState |
shipping_state |
VARCHAR |
ShippingStateCode |
shipping_state_code |
VARCHAR |
ShippingPostalCode |
shipping_postal_code |
VARCHAR |
ShippingCountry |
shipping_country |
VARCHAR |
ShippingCountryCode |
shipping_country_code |
VARCHAR |
ShippingGeocodeAccuracy |
shipping_geocode_accuracy |
VARCHAR |
ShippingLatitude |
shipping_latitude |
FLOAT |
ShippingLongitude |
shipping_longitude |
FLOAT |
Phone |
phone |
VARCHAR |
PhotoUrl |
photo_url |
VARCHAR |
Industry |
industry |
VARCHAR |
Website |
website |
VARCHAR |
NumberOfEmployees |
number_of_employees |
VARCHAR |
Description |
description |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OwnerId |
owner_id |
VARCHAR |
AccountNumber |
account_number |
VARCHAR |
HasOptedOutOfEmail |
has_opted_out_of_email |
BOOLEAN |
PersonContactId |
person_contact_id |
VARCHAR |
IsPersonAccount |
is_person_account |
BOOLEAN |
PersonEmail |
person_email |
VARCHAR |
PersonMailingStreet |
person_mailing_street |
VARCHAR |
PersonMailingCity |
person_mailing_city |
VARCHAR |
PersonMailingState |
person_mailing_state |
VARCHAR |
PersonMailingPostalCode |
person_mailing_postal_code |
VARCHAR |
PersonMailingCountry |
person_mailing_country |
VARCHAR |
PersonMailingGeocodeAccuracy |
person_mailing_geocode_accuracy |
VARCHAR |
PersonMailingLatitude |
person_mailing_latitude |
FLOAT |
PersonMailingLongitude |
person_mailing_longitude |
FLOAT |
PersonBirthDate |
person_birth_date |
TIMESTAMP |
PersonHomePhone |
person_home_phone |
VARCHAR |
PersonMobilePhone |
person_mobile_phone |
VARCHAR |
PersonTitle |
person_title |
VARCHAR |
PersonDepartment |
person_department |
VARCHAR |
PersonEmailBouncedDate |
person_email_bounced_date |
TIMESTAMP |
PersonEmailBouncedReason |
person_email_bounced_reason |
VARCHAR |
PersonHasOptedOutOfEmail |
person_has_opted_out_of_email |
BOOLEAN |
AccountSource |
account_source |
VARCHAR |
Sic |
sic |
VARCHAR |
SicDesc |
sic_desc |
VARCHAR |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastActivityDate |
last_activity_date |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
account_id + __shop_id |
ACCOUNT CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
account_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
account_id + custom_attribute_key + __shop_id |
ENDPOINT: SOM Contacts
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm)
CONTACTS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
contact_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
MasterRecordId |
master_record_id |
VARCHAR |
AccountId |
account_id |
VARCHAR |
IsPersonAccount |
is_person_account |
BOOLEAN |
CanAllowPortalSelfReg |
can_allow_portal_self_reg |
BOOLEAN |
DoNotCall |
do_not_call |
BOOLEAN |
LastName |
last_name |
VARCHAR |
FirstName |
first_name |
VARCHAR |
Salutation |
salutation |
VARCHAR |
MiddleName |
middle_name |
VARCHAR |
Suffix |
suffix |
VARCHAR |
Name |
name |
VARCHAR |
MailingStreet |
mailing_street |
VARCHAR |
MailingCity |
mailing_city |
VARCHAR |
MailingState |
mailing_state |
VARCHAR |
MailingPostalCode |
mailing_postal_code |
VARCHAR |
MailingCountry |
mailing_country |
VARCHAR |
MailingLatitude |
mailing_latitude |
FLOAT |
MailingLongitude |
mailing_longitude |
FLOAT |
MailingGeocodeAccuracy |
mailing_geocode_accuracy |
VARCHAR |
Phone |
phone |
VARCHAR |
Fax |
fax |
VARCHAR |
MobilePhone |
mobile_phone |
VARCHAR |
ReportsToId |
reports_to_id |
VARCHAR |
|
|
VARCHAR |
Title |
title |
VARCHAR |
Department |
department |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OwnerId |
owner_id |
VARCHAR |
EmailBouncedReason |
email_bounced_reason |
VARCHAR |
EmailBouncedDate |
email_bounced_at |
TIMESTAMP |
IsEmailBounced |
is_email_bounced |
BOOLEAN |
HasOptedOutOfEmail |
has_opted_out_of_email |
BOOLEAN |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
LastActivityDate |
last_activity_date |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
contact_id + __shop_id |
ENDPOINT: SOM FulfillmentOrderItemTax
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderitemadjustment.htm)
FULFILLMENT ORDER ITEM TAXES TABLE
Data Mapping
JSON Element |
Database Column |
Datatype |
Id |
fulfillment_order_item_adjustment_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
FulfillmentOrderItemAdjustmentNumber |
fulfillment_order_item_adjustment_number |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
FulfillmentOrderLineItemId |
fulfillment_order_line_item_id |
VARCHAR |
FulfillmentOrderId |
fulfillment_order_id |
VARCHAR |
OrderItemAdjustLineSummaryId |
order_item_adjustment_line_summary_id |
VARCHAR |
CampaignName |
campaign_name |
VARCHAR |
CouponName |
coupon_name |
VARCHAR |
PromotionName |
promotion_name |
VARCHAR |
Description |
description |
VARCHAR |
TotalTaxAmount |
total_tax_amount |
FLOAT |
Amount |
amount |
FLOAT |
CreatedDate |
created_by_id |
VARCHAR |
CreatedById |
created_at |
TIMESTAMP |
LastModifiedDate |
updated_by_id |
VARCHAR |
LastModifiedById |
updated_at |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
fulfillment_order_item_adjusment_id + __shop_id |
ENDPOINT: SOM FulfillmentOrderLineItem
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_fulfillmentorderlineitem.htm)
FULFILLMENT ORDER LINE ITEMS TABLE
Data Mapping
JSON Element |
Database Column |
Datatype |
Id |
fulfillment_order_item_tax_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
FulfillmentOrderItemTaxNumber |
fulfillment_order_item_tax_number |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
FulfillmentOrderLineItemId |
fulfillment_order_line_item_id |
VARCHAR |
FulfillmentOrderId |
fulfillment_order_id |
VARCHAR |
OrderItemTaxLineItemSummaryId |
order_item_tax_line_item_summary_id |
VARCHAR |
FulfillmentOrderItemAdjustId |
fulfillment_order_item_adjust_id |
VARCHAR |
Type |
type |
VARCHAR |
Amount |
amount |
FLOAT |
Description |
description |
VARCHAR |
Rate |
rate |
FLOAT |
TaxEffectiveDate |
tax_effective_date |
TIMESTAMP |
CreatedDate |
created_by_id |
VARCHAR |
CreatedById |
created_at |
TIMESTAMP |
LastModifiedDate |
updated_by_id |
VARCHAR |
LastModifiedById |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
fulfillment_order_item_tax_id + __shop_id |
FULFILLMENT ORDER LINE ITEM CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
fulfillment_order_line_item_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
fulfillment_order_line_item_id + custom_attribute_key + __shop_id |
ENDPOINT: SOM OrderAdjustmentGroupSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderadjustmentgroupsummary.htm)
ORDER ADJUSTMENT GROUP SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_adjusment_group_summary_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
Name |
name |
VARCHAR |
Description |
description |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OrderSummaryId |
order_summary_id |
VARCHAR |
OriginalOrderAdjGroupId |
original_order_adj_group_id |
VARCHAR |
Type |
type |
VARCHAR |
TotalAmount |
total_amount |
FLOAT |
TotalTaxAmount |
total_tax_amount |
FLOAT |
GrandTotalAmount |
grand_total_amount |
FLOAT |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_adjusment_group_summary_id + __shop_id |
ENDPOINT: SOM OrderDeliveryGroupSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderdeliverygroupsummary.htm)
ORDER DELIVERY GROUP SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_delivery_group_summary_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
Description |
description |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OrderDeliveryGroupSummaryNumber |
order_delivery_group_summary_number |
VARCHAR |
OrderSummaryId |
order_summary_id |
VARCHAR |
OriginalOrderDeliveryGroupId |
original_order_delivery_group_id |
VARCHAR |
OrderDeliveryMethodId |
order_delivery_method_id |
VARCHAR |
EmailAddress |
email_address |
VARCHAR |
PhoneNumber |
phone_number |
VARCHAR |
DeliverToName |
deliver_to_name |
VARCHAR |
DeliverToStreet |
deliver_to_street |
VARCHAR |
DeliverToCity |
deliver_to_city |
VARCHAR |
DeliverToState |
deliver_to_state |
VARCHAR |
DeliverToPostalCode |
deliver_to_postal_code |
VARCHAR |
DeliverToCountry |
deliver_to_country |
VARCHAR |
DeliverToLatitude |
deliver_to_latitude |
FLOAT |
DeliverToLongitude |
deliver_to_longitude |
FLOAT |
DeliverToGeocodeAccuracy |
deliver_to_geocode_accuracy |
VARCHAR |
GiftMessage |
gift_message |
VARCHAR |
IsGift |
is_gift |
BOOLEAN |
DeliveryInstructions |
delivery_instructions |
VARCHAR |
DesiredDeliveryDate |
desired_delivery_date |
TIMESTAMP |
PromisedDeliveryDate |
promised_delivery_date |
TIMESTAMP |
TotalLineAmount |
total_line_amount |
FLOAT |
TotalLineTaxAmount |
total_line_tax_amount |
FLOAT |
TotalAdjustmentAmount |
total_adjustment_amount |
FLOAT |
TotalAdjustmentTaxAmount |
total_adjustment_tax_amount |
FLOAT |
TotalAmount |
total_amount |
FLOAT |
TotalTaxAmount |
total_tax_amount |
FLOAT |
GrandTotalAmount |
grand_total_amount |
FLOAT |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_delivery_group_summary_id + __shop_id |
ORDER DELIVERY GROUP CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
order_delivery_group_summary_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_delivery_group_summary_id + custom_attribute_key + __shop_id |
ENDPOINT: SOM OrderItemSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemsummary.htm)
ORDER ITEM SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_item_summary_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
Name |
name |
VARCHAR |
Description |
description |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OrderSummaryId |
order_summary_id |
VARCHAR |
OriginalOrderItemId |
original_order_item_id |
VARCHAR |
OrderDeliveryGroupSummaryId |
order_delivery_group_summary_id |
VARCHAR |
Status |
order_item_status |
VARCHAR |
Product2Id |
product_2_id |
VARCHAR |
ProductCode |
product_code |
VARCHAR |
LineNumber |
line_number |
INT |
Type |
type |
VARCHAR |
TypeCode |
type_code |
VARCHAR |
Quantity |
quantity |
FLOAT |
QuantityAllocated |
quantity_allocated |
FLOAT |
QuantityCanceled |
quantity_canceled |
FLOAT |
QuantityOrdered |
quantity_ordered |
FLOAT |
QuantityFulfilled |
quantity_fulfilled |
FLOAT |
QuantityReturned |
quantity_returned |
FLOAT |
QuantityReturnInitiated |
quantity_return_initiated |
FLOAT |
QuantityNetOrdered |
quantity_net_ordered |
FLOAT |
QuantityAvailableToCancel |
quantity_available_to_cancel |
FLOAT |
QuantityAvailableToReturn |
quantity_available_to_return |
FLOAT |
QuantityAvailableToFulfill |
quantity_available_to_fulfill |
FLOAT |
ListPrice |
list_price |
FLOAT |
UnitPrice |
unit_price |
FLOAT |
TotalPrice |
total_price |
FLOAT |
AdjustedLineAmount |
adjusted_line_amount |
FLOAT |
TotalAdjustedLineTaxAmount |
total_adjusted_line_tax_amount |
FLOAT |
TotalTaxAmount |
total_tax_amount |
FLOAT |
TotalAdjustmentAmount |
total_adjustment_amount |
FLOAT |
TotalAdjustmentTaxAmount |
total_adjustment_tax_amount |
FLOAT |
TotalLineAmount |
total_line_amount |
FLOAT |
TotalLineTaxAmount |
total_line_tax_amount |
FLOAT |
TotalLineAdjustmentAmount |
total_line_adjustment_amount |
FLOAT |
TotalLineAdjustmentTaxAmount |
total_line_adjustment_tax_amount |
FLOAT |
TotalAdjustmentDistAmount |
total_adjustment_dist_amount |
FLOAT |
TotalAdjustmentDistTaxAmount |
total_adjustment_dist_tax_amount |
FLOAT |
ServiceDate |
service_date |
TIMESTAMP |
EndDate |
end_date |
TIMESTAMP |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_summary_id + __shop_id |
ORDER ITEM SUMMARY CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
order_item_summary_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_item_summary_id + custom_attribute_key + __shop_id |
ENDPOINT: SOM OrderItemTaxLineSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderitemtaxlineitemsummary.htm)
ORDER ITEM TAX LINE SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_item_tax_line_summary_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
Name |
name |
VARCHAR |
Description |
description |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OrderSummaryId |
order_summary_id |
VARCHAR |
OrderItemSummaryId |
order_item_summary_id |
VARCHAR |
OriginalOrderItemTaxLineItemId |
original_order_item_tax_line_item_id |
VARCHAR |
OrderItemAdjustmentLineSummaryId |
order_item_adjustment_line_summary_id |
VARCHAR |
Type |
type |
VARCHAR |
Rate |
rate |
FLOAT |
Amount |
amount |
FLOAT |
TaxEffectiveDate |
tax_effective_date |
TIMESTAMP |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_item_tax_summary_id + __shop_id |
ENDPOINT: SOM OrderPaymentSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_orderpaymentsummary.htm)
ORDER PAYMENT SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_payment_summary_id |
VARCHAR |
OwnerId |
owner_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
Method |
method |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OrderSummaryId |
order_summary_id |
VARCHAR |
PaymentMethodId |
payment_method_id |
VARCHAR |
LastPaymentGatewayLogId |
last_payment_gateway_log_id |
VARCHAR |
LastPaymentGatewayMessage |
last_payment_gateway_message |
VARCHAR |
FullName |
full_name |
VARCHAR |
Type |
type |
VARCHAR |
AuthorizationReversalAmount |
authorization_reversal_amount |
FLOAT |
AuthorizationAmount |
authorization_amount |
FLOAT |
CapturedAmount |
captured_amount |
FLOAT |
BalanceAmount |
balance_amount |
FLOAT |
PendingAuthorizationAmount |
pending_authorization_amount |
FLOAT |
PendingReverseAuthAmount |
pending_reverse_auth_amount |
FLOAT |
PendingCaptureAmount |
pending_capture_amount |
FLOAT |
PendingRefundAmount |
pending_refund_amount |
FLOAT |
RefundedAmount |
refunded_amount |
FLOAT |
AvailableToRefundAmount |
available_to_refund_amount |
FLOAT |
AvailableToCaptureAmount |
available_to_capture_amount |
FLOAT |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_payment_summary_id + __shop_id |
ENDPOINT: SOM OrderSummary
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_ordersummary.htm)
ORDER SUMMARIES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
order_summary_id |
VARCHAR |
OwnerId |
owner_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
OrderNumber |
order_number |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
OriginalOrderId |
original_order_id |
VARCHAR |
AccountId |
account_id |
VARCHAR |
ChangeOrderId |
change_order_id |
VARCHAR |
TotalAmount |
total_amount |
FLOAT |
GrandTotalAmount |
grand_total_amount |
FLOAT |
TotalAdjDistAmount |
total_adj_dist_amount |
FLOAT |
TotalAdjDistTaxAmount |
total_adj_dist_tax_amount |
FLOAT |
BillingStreet |
billing_street |
VARCHAR |
BillingCity |
billing_city |
VARCHAR |
BillingState |
billing_state |
VARCHAR |
BillingPostalCode |
billing_postal_code |
VARCHAR |
BillingCountry |
billing_country |
VARCHAR |
BillingLatitude |
billing_latitude |
FLOAT |
BillingLongitude |
billing_longitude |
FLOAT |
BillingGeocodeAccuracy |
billing_geocode_accuracy |
VARCHAR |
BillingEmailAddress |
billing_email_address |
VARCHAR |
BillingPhoneNumber |
billing_phone_number |
VARCHAR |
OrderedDate |
order_date |
TIMESTAMP |
TotalTaxAmount |
total_tax_amount |
FLOAT |
Status |
order_status |
VARCHAR |
Description |
description |
VARCHAR |
SalesChannelId |
sales_channel_id |
VARCHAR |
PoNumber |
po_number |
VARCHAR |
TotalAdjustedProductAmount |
total_adjusted_product_amount |
FLOAT |
TotalAdjustedDeliveryAmount |
total_adjusted_delivery_amount |
FLOAT |
TotalProductAdjDistAmount |
total_product_adj_dist_amount |
FLOAT |
TotalDeliveryAdjDistAmount |
total_delivery_adj_dist_amount |
FLOAT |
TotalAdjustedProductTaxAmount |
total_adjusted_product_tax_amount |
FLOAT |
TotalAdjustedDeliveryTaxAmount |
total_adjusted_delivery_tax_amount |
FLOAT |
TotalProductAdjDistTaxAmount |
total_product_adj_dist_tax_amount |
FLOAT |
TotalDeliveryAdjDistTaxAmount |
total_delivery_adj_dist_tax_amount |
FLOAT |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_summary_id + __shop_id |
ORDER SUMMARY CUSTOM ATTRIBUTES TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
id |
order_summary_id |
VARCHAR |
key |
custom_attribute_key |
VARCHAR |
value |
custom_attribute_value |
VARCHAR |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
order_summary_id + custom_attribute_key + __shop_id |
ENDPOINT: SOM SalesChannels
Account Object (https://developer.salesforce.com/docs/atlas.en-us.object_reference.meta/object_reference/sforce_api_objects_contact.htm)
SALES CHANNELS TABLE
Data Mapping.
JSON Element |
Database Column |
Datatype |
Id |
sales_channel_id |
VARCHAR |
OwnerId |
owner_id |
VARCHAR |
IsDeleted |
is_deleted |
BOOLEAN |
SalesChannelName |
sales_channel_name |
VARCHAR |
CurrencyIsoCode |
currency_iso_code |
VARCHAR |
ExternalChannelNumber |
external_channel_number |
VARCHAR |
Description |
description |
VARCHAR |
CreatedById |
created_by_id |
VARCHAR |
CreatedDate |
created_at |
TIMESTAMP |
LastModifiedById |
updated_by_id |
VARCHAR |
LastModifiedDate |
updated_at |
TIMESTAMP |
LastReferencedDate |
last_referenced_date |
TIMESTAMP |
LastViewedDate |
last_viewed_date |
TIMESTAMP |
Business Rules.
Business Rule |
Value |
Load Type |
Upsert |
Extraction Frequency |
Daily |
Sync Key |
sales_channel_id + __shop_id |