Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

Any of these objects should trigger reverse synchronization:

  1. Inventory Source.

  2. Inventory Source Item.

  3. Inventory Stock.

  4. Inventory Stock Sales Channel.

  5. Inventory Source Stock Link.

Specific scenarios:

  1. Inventory Source synchronization: add Inventory Source data to the queue.

  2. Inventory Source Item synchronization: run linked Product synchronization (see Scenario 3).

  3. Product synchronization: Inventory Source Item data should be nested into Product data, Inventory Source data should be nested into Inventory Source Item data.

  4. Inventory Stock Sales Channel synchronization: run linked Inventory Stock synchronization (see Scenario 6).

  5. Inventory Source Stock Link synchronization: run linked Inventory Stock synchronization (see Scenario 6).

  6. Inventory Stock synchronization: add Inventory Stock data to the queue. Inventory Stock Sales Channel data and Inventory Source Stock Link should be nested into Inventory Stock data. Website data should be nested into Inventory Stock Sales Channel data. Inventory Source data should be nested into Inventory Source Stock Link data.

Request payload structure:

{
  "sf": [
    {
      "attributes": {
        "type": "<Object API Name>",
        "url": "<Instance URL>"
      },
      "Id": "<Instance Salesforce Id>",
      "<Object Standard Field 1>": "<Instance field value>",
      "<Object Standard Field N>": "<Instance field value>",
      "<Object Custom Field 1>": "<Instance field value>",
      "<Object Custom Field N>": "<Instance field value>",
      "<Related Object API Name 1>": {
        "totalSize": "<Number of records>",
        "done": true,
        "records": [
          {
            "attributes": {
              "type": "<Related Object 1 API Name>",
              "url": "<Related Instance 1 URL>"
            },
            "Id": "<Related Instance 1 Salesforce Id>",
            "<Object Standard Field 1>": "<Related Instance 1 field value>",
            "<Object Standard Field N>": "<Related Instance 1 field value>",
            "<Object Custom Field 1>": "<Related Instance 1 field value>",
            "<Object Custom Field N>": "<Related Instance 1 field value>",
            "<Related Object API Name 1.1>": {
              "totalSize": "<Number of records>",
              "done": true,
              "records": [
                {
                  "attributes": {
                    "type": "<Related Object 1.1 API Name>",
                    "url": "<Related Instance 1.1 URL>"
                  },
                  "Id": "<Related Instance 1.1 Salesforce Id>",
                  "<Object Standard Field 1>": "<Related Instance 1.1 field value>",
                  "<Object Standard Field N>": "<Related Instance 1.1 field value>",
                  "<Object Custom Field 1>": "<Related Instance 1.1 field value>",
                  "<Object Custom Field N>": "<Related Instance 1.1 field value>"
                }
              ]
            },
            "<Related Object API Name 1.N>": {
              "totalSize": "<Number of records>",
              "done": true,
              "records": [
                {
                  "attributes": {
                    "type": "<Related Object 1.N API Name>",
                    "url": "<Related Instance 1.N URL>"
                  },
                  "Id": "<Related Instance 1.N  Salesforce Id>",
                  "<Object Standard Field 1>": "<Related Instance 1.N field value>",
                  "<Object Standard Field N>": "<Related Instance 1.N field value>",
                  "<Object Custom Field 1>": "<Related Instance 1.N field value>",
                  "<Object Custom Field N>": "<Related Instance 1.N field value>"
                }
              ]
            }
          }
        ]
      },
      "<Related Object API Name N>": {
        "totalSize": "<Number of records>",
        "done": true,
        "records": [
          {
            "attributes": {
              "type": "<Related Object N API Name>",
              "url": "<Related Instance N URL>"
            },
            "Id": "<Related Instance N Salesforce Id>",
            "<Object Standard Field 1>": "<Related Instance N field value>",
            "<Object Standard Field N>": "<Related Instance N field value>",
            "<Object Custom Field 1>": "<Related Instance N field value>",
            "<Object Custom Field N>": "<Related Instance N field value>",
            "<Related Object API Name N.1>": {
              "totalSize": "<Number of records>",
              "done": true,
              "records": [
                {
                  "attributes": {
                    "type": "<Related Object N.1 API Name>",
                    "url": "<Related Instance N.1 URL>"
                  },
                  "Id": "<Related Instance N.1 Salesforce Id>",
                  "<Object Standard Field 1>": "<Related Instance N.1 field value>",
                  "<Object Standard Field N>": "<Related Instance N.1 field value>",
                  "<Object Custom Field 1>": "<Related Instance N.1 field value>",
                  "<Object Custom Field N>": "<Related Instance N.1 field value>"
                }
              ]
            },
            "<Related Object API Name N.N>": {
              "totalSize": "<Number of records>",
              "done": true,
              "records": [
                {
                  "attributes": {
                    "type": "<Related Object N.N API Name>",
                    "url": "<Related Instance N.N URL>"
                  },
                  "Id": "<Related Instance N.N  Salesforce Id>",
                  "<Object Standard Field 1>": "<Related Instance N.N field value>",
                  "<Object Standard Field N>": "<Related Instance N.N field value>",
                  "<Object Custom Field 1>": "<Related Instance N.N field value>",
                  "<Object Custom Field N>": "<Related Instance N.N field value>"
                }
              ]
            }
          }
        ]
      }
    }
  ]
}

Example request payload:

  1. Inventory Source

    {
      "sf": [
        {
          "attributes": {
            "type": "Inventory_Source__c",
            "url": "/services/data/v54.0/sobjects/Inventory_Source/01t08000009hOSUAA2"
          },
          "Id": "01t08000009hOSUAA2",
          "OwnerId": "00509000006om58AAA",
          "IsDeleted": false,
          "Name": "Source 6 Name",
          "Source_Code__c": "source6",
          "Enabled__c": "1",
          "Description__c": "Some Description",
          "Postcode__c": "123456",
          "Use_Default_Carrier_Config__c": "1",
          "Country_Id__c": "AZ",
          "Frontend_Name__c": "Source 6 Frontend Name",
          "CreatedDate": "2022-03-03T10:53:23.000+0000",
          "CreatedById": "00524000000eEKzAAM",
          "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
          "LastModifiedById": "00524000000eEKzAAM",
          "SystemModstamp": "2022-03-03T10:53:23.000+0000"
        }
      ]
    }
  2. Inventory Source Item

    {
      "sf": [
        {
          "attributes": {
            "type": "Inventory_Source_Item__c",
            "url": "/services/data/v54.0/sobjects/Inventory_Source_Item__c/a005f000008Iu4y"
          },
          "Id": "a005f000008Iu4y",
          "OwnerId": "00509000006om58AAA",
          "IsDeleted": false,
          "Name": "default:vebkotwi",
          "Inventory_Source_Field__c": "a015f00000JwLgn",
          "Magento_ID__c": "5",
          "Product__c": "01t09000004fahVAAQ",
          "Quantity__c": "27",
          "Status__c": "1",
          "CreatedDate": "2022-03-03T10:53:23.000+0000",
          "CreatedById": "00524000000eEKzAAM",
          "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
          "LastModifiedById": "00524000000eEKzAAM",
          "SystemModstamp": "2022-03-03T10:53:23.000+0000",
          "Product2": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Product2",
                  "url": "/services/data/v54.0/sobjects/Product2/01t08000009hOSUAA2"
                },
                "Id": "01t08000009hOSUAA2",
                "Name": "mowockag!!!",
                "ProductCode": "vebkotwi",
                "IsActive": true,
                "CreatedDate": "2022-03-03T10:53:21.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:21.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000",
                "CurrencyIsoCode": "USD",
                "IsDeleted": false,
                "LastViewedDate": "2022-03-12T18:31:06.000+0000",
                "LastReferencedDate": "2022-03-12T18:31:06.000+0000",
                "tnw_mage_basic__Attribute_Set__c": "Default",
                "tnw_mage_basic__Magento_ID__c": "964",
                "tnw_mage_basic__Product_Type__c": "Simple Product",
                "tnw_mage_enterp__disableMagentoSync__c": false,
                "PricebookEntries": {
                  "totalSize": 1,
                  "done": true,
                  "records": [
                    {
                      "attributes": {
                        "type": "PricebookEntry",
                        "url": "/services/data/v54.0/sobjects/PricebookEntry/01u0800000Z4vj6AAB"
                      },
                      "Product2Id": "01t08000009hOSUAA2",
                      "Id": "01u0800000Z4vj6AAB",
                      "Name": "mowockag",
                      "Pricebook2Id": "01s5f000008ntcu",
                      "CurrencyIsoCode": "EUR",
                      "UnitPrice": 89.19,
                      "IsActive": true,
                      "UseStandardPrice": false,
                      "CreatedDate": "2022-03-03T10:53:23.000+0000",
                      "CreatedById": "00524000000eEKzAAM",
                      "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                      "LastModifiedById": "00524000000eEKzAAM",
                      "SystemModstamp": "2022-03-03T10:53:23.000+0000",
                      "ProductCode": "vebkotwi",
                      "IsDeleted": false
                    }
                  ]
                }
              }
            ]
          },
          "Inventory_Source__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Source__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Source/01t08000009hOSUAA2"
                },
                "Id": "01t08000009hOSUAA2",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Source 6 Name",
                "Source_Code__c": "source6",
                "Enabled__c": "1",
                "Description__c": "Some Description",
                "Postcode__c": "123456",
                "Use_Default_Carrier_Config__c": "1",
                "Country_Id__c": "AZ",
                "Frontend_Name__c": "Source 6 Frontend Name",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000"
              }
            ]
          }
        }
      ]
    }
  3. Product

    Not yet implemented
  4. Inventory Stock Sales Channel

    {
      "sf": [
        {
          "attributes": {
            "type": "Inventory_Stock_Sales_Channel__c",
            "url": "/services/data/v54.0/sobjects/Inventory_Stock_Sales_Channel__c/a0G5f000002ZDLC"
          },
          "Id": "a0G5f000002ZDLC",
          "OwnerId": "00509000006om58AAA",
          "IsDeleted": false,
          "Name": "website:custom",
          "Inventory_Stock_Lookup__c": "a0E5f000001q6t3",
          "Magento_ID__c": "website_base",
          "Magento_Website_Lookup__c": "a020900000CflqUAAR",
          "Type__c": "website",
          "CreatedDate": "2022-03-03T10:53:23.000+0000",
          "CreatedById": "00524000000eEKzAAM",
          "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
          "LastModifiedById": "00524000000eEKzAAM",
          "SystemModstamp": "2022-03-03T10:53:23.000+0000",
          "tnw_mage_basic__Magento_Website__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "tnw_mage_basic__Magento_Website__c",
                  "url": "/services/data/v54.0/sobjects/tnw_mage_basic__Magento_Website__c/a020900000CflqUAAR"
                },
                "Id": "a020900000CflqUAAR",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Custom Website",
                "CurrencyIsoCode": "USD",
                "CreatedDate": "2022-01-27T15:51:23.000+0000",
                "CreatedById": "00509000006om58AAA",
                "LastModifiedDate": "2022-04-30T09:30:45.000+0000",
                "LastModifiedById": "00509000006om58AAA",
                "SystemModstamp": "2022-04-30T09:30:45.000+0000",
                "LastViewedDate": "2022-04-30T09:33:36.000+0000",
                "LastReferencedDate": "2022-04-30T09:33:36.000+0000",
                "tnw_mage_basic__Code__c": "cw",
                "tnw_mage_basic__Price_Book__c": "01s0900000IsT7SAAZ",
                "tnw_mage_basic__Sort_Order__c": 5,
                "tnw_mage_basic__Website_ID__c": 11,
                "tnw_mage_enterp__disableMagentoSync__c": false
              }
            ]
          },
          "Inventory_Stock__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Stock__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Stock__c/a0E5f000001q6t3"
                },
                "Id": "a0E5f000001q6t3",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Stock Custom Name",
                "Magento_ID__c": "11",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000"
              }
            ]
          }
        }
      ]
    }
  5. Inventory Source Stock Link

    {
      "sf": [
        {
          "attributes": {
            "type": "Inventory_Stock_Source_Link__c",
            "url": "/services/data/v54.0/sobjects/Inventory_Stock_Source_Link__c/a0F5f000001S1oN"
          },
          "Id": "a0F5f000001S1oN",
          "OwnerId": "00509000006om58AAA",
          "IsDeleted": false,
          "Name": "Stock 10 Name:source15code",
          "Inventory_Source_Lookup__c": "a015f00000JxAN7",
          "Inventory_Stock_Lookup__c": "a0E5f000001q6t3",
          "Magento_ID__c": "30",
          "Priority__c": "5",
          "CreatedDate": "2022-03-03T10:53:23.000+0000",
          "CreatedById": "00524000000eEKzAAM",
          "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
          "LastModifiedById": "00524000000eEKzAAM",
          "SystemModstamp": "2022-03-03T10:53:23.000+0000",
          "Inventory_Stock__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Stock__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Stock__c/a0E5f000001q6t3"
                },
                "Id": "a0E5f000001q6t3",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Stock 10 Name",
                "Magento_ID__c": "10",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000"
              }
            ]
          },
          "Inventory_Source__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Source__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Source/a015f00000JxAN7"
                },
                "Id": "a015f00000JxAN7",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Source 15 Name",
                "Source_Code__c": "source15code",
                "Enabled__c": "1",
                "Description__c": "Some Description",
                "Postcode__c": "12345678",
                "Use_Default_Carrier_Config__c": "0",
                "Country_Id__c": "AN",
                "Frontend_Name__c": "Source 15 Frontend Name",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000"
              }
            ]
          }
        }
      ]
    }
  6. Inventory Stock

    {
      "sf": [
        {
          "attributes": {
            "type": "Inventory_Stock__c",
            "url": "/services/data/v54.0/sobjects/Inventory_Stock__c/a0E5f000001q6t3"
          },
          "Id": "a0E5f000001q6t3",
          "OwnerId": "00509000006om58AAA",
          "IsDeleted": false,
          "Name": "Stock 10 Name",
          "Magento_ID__c": "10",
          "CreatedDate": "2022-03-03T10:53:23.000+0000",
          "CreatedById": "00524000000eEKzAAM",
          "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
          "LastModifiedById": "00524000000eEKzAAM",
          "SystemModstamp": "2022-03-03T10:53:23.000+0000",
          "Inventory_Stock_Source_Link__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Stock_Source_Link__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Stock_Source_Link__c/a0F5f000001S1oN"
                },
                "Id": "a0F5f000001S1oN",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "Stock 10 Name:source15code",
                "Inventory_Source_Lookup__c": "a015f00000JxAN7",
                "Inventory_Stock_Lookup__c": "a0E5f000001q6t3",
                "Magento_ID__c": "30",
                "Priority__c": "5",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000",
                "Inventory_Source__c": {
                  "totalSize": 1,
                  "done": true,
                  "records": [
                    {
                      "attributes": {
                        "type": "Inventory_Source__c",
                        "url": "/services/data/v54.0/sobjects/Inventory_Source/a015f00000JxAN7"
                      },
                      "Id": "a015f00000JxAN7",
                      "OwnerId": "00509000006om58AAA",
                      "IsDeleted": false,
                      "Name": "Source 15 Name",
                      "Source_Code__c": "source15code",
                      "Enabled__c": "1",
                      "Description__c": "Some Description",
                      "Postcode__c": "12345678",
                      "Use_Default_Carrier_Config__c": "0",
                      "Country_Id__c": "AN",
                      "Frontend_Name__c": "Source 15 Frontend Name",
                      "CreatedDate": "2022-03-03T10:53:23.000+0000",
                      "CreatedById": "00524000000eEKzAAM",
                      "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                      "LastModifiedById": "00524000000eEKzAAM",
                      "SystemModstamp": "2022-03-03T10:53:23.000+0000"
                    }
                  ]
                }
              }
            ]
          },
          "Inventory_Stock_Sales_Channel__c": {
            "totalSize": 1,
            "done": true,
            "records": [
              {
                "attributes": {
                  "type": "Inventory_Stock_Sales_Channel__c",
                  "url": "/services/data/v54.0/sobjects/Inventory_Stock_Sales_Channel__c/a0G5f000002ZDLC"
                },
                "Id": "a0G5f000002ZDLC",
                "OwnerId": "00509000006om58AAA",
                "IsDeleted": false,
                "Name": "website:custom",
                "Inventory_Stock_Lookup__c": "a0E5f000001q6t3",
                "Magento_ID__c": "website_custom",
                "Magento_Website_Lookup__c": "a020900000CflqUAAR",
                "Type__c": "website",
                "CreatedDate": "2022-03-03T10:53:23.000+0000",
                "CreatedById": "00524000000eEKzAAM",
                "LastModifiedDate": "2022-03-03T10:53:23.000+0000",
                "LastModifiedById": "00524000000eEKzAAM",
                "SystemModstamp": "2022-03-03T10:53:23.000+0000",
                "tnw_mage_basic__Magento_Website__c": {
                  "totalSize": 1,
                  "done": true,
                  "records": [
                    {
                      "attributes": {
                        "type": "tnw_mage_basic__Magento_Website__c",
                        "url": "/services/data/v54.0/sobjects/tnw_mage_basic__Magento_Website__c/a020900000CflqUAAR"
                      },
                      "Id": "a020900000CflqUAAR",
                      "OwnerId": "00509000006om58AAA",
                      "IsDeleted": false,
                      "Name": "Custom Website",
                      "CurrencyIsoCode": "USD",
                      "CreatedDate": "2022-01-27T15:51:23.000+0000",
                      "CreatedById": "00509000006om58AAA",
                      "LastModifiedDate": "2022-04-30T09:30:45.000+0000",
                      "LastModifiedById": "00509000006om58AAA",
                      "SystemModstamp": "2022-04-30T09:30:45.000+0000",
                      "LastViewedDate": "2022-04-30T09:33:36.000+0000",
                      "LastReferencedDate": "2022-04-30T09:33:36.000+0000",
                      "tnw_mage_basic__Code__c": "cw",
                      "tnw_mage_basic__Price_Book__c": "01s0900000IsT7SAAZ",
                      "tnw_mage_basic__Sort_Order__c": 5,
                      "tnw_mage_basic__Website_ID__c": 11,
                      "tnw_mage_enterp__disableMagentoSync__c": false
                    }
                  ]
                }
              }
            ]
          }
        }
      ]
    }
  • No labels