Zynk Workflow

https://docs.zynk.com
Admin
Zynk Workflow is an integration platform that provides user guides, developer documentation, and...
Tokens:1,680,669
Snippets:11,799
Trust Score:8.8
Update:8 months ago
Show doc for...
Tokens:
Raw
### GET /orders/{order_id}/products

Source: https://docs.zynk.com/workflow/documentation/bigcommerce-v3/export-orders

Retrieves a list of products associated with a specific order.

```APIDOC
## GET /orders/{order_id}/products

### Description
Retrieves a list of products associated with a specific order, including details like product ID, name, quantity, and pricing.

### Method
GET

### Endpoint
/orders/{order_id}/products

### Parameters
#### Path Parameters
- **order_id** (integer) - Required - The unique identifier of the order.

### Request Example
```
GET /stores/v5k4i/v2/orders/104/products
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the order product.
- **order_id** (integer) - The ID of the order this product belongs to.
- **product_id** (integer) - The ID of the product.
- **name** (string) - The name of the product.
- **sku** (string) - The SKU of the product.
- **quantity** (integer) - The quantity of the product ordered.
- **base_price** (number) - The base price of the product.
- **price_inc_tax** (number) - The price of the product including tax.
- **total_inc_tax** (number) - The total price of the product line item including tax.

#### Response Example
```json
{
  "id": 6,
  "order_id": 104,
  "product_id": 186,
  "order_address_id": 5,
  "name": "iPhone 4 16GB White",
  "sku": "IPHONE4",
  "type": "physical",
  "base_price": 499.0000,
  "price_exc_tax": null,
  "price_inc_tax": 598.8000,
  "price_tax": 99.8000,
  "base_total": 499.0000,
  "total_exc_tax": null,
  "total_inc_tax": 598.8000,
  "total_tax": 99.8000,
  "quantity": 1,
  "weight": 0.0000,
  "width": 0.0000,
  "depth": 0.0000,
  "height": 0.0000,
  "is_refunded": false,
  "wrapping_name": null,
  "quantity_shipped": 0,
  "fixed_shipping_cost": 0.0000,
  "is_bundled_product": false
}
```
```

--------------------------------

### XML Example for Inventory Import

Source: https://docs.zynk.com/workflow/developers/mintsoft/inventory_q=

This XML structure demonstrates how to format inventory data for import into Mintsoft via Zynk. It includes essential fields like ExternalID, SKU, Quantity, and warehouse/client details, showcasing different matching options.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Inventories
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Inventory>
    <ExternalID>TEST0001</ExternalID>
    <SKU>TEST0001</SKU>
    <Quantity>100</Quantity>
    <MatchWarehouseOn>Name</MatchWarehouseOn>
    <Warehouse>
        <Name>Site 1</Name>
    </Warehouse>
    <MatchClientOn>Name</MatchClientOn>
    <Client>
      <Name>Hikari</Name>
    </Client>
  </Inventory>
  <Inventory>
    <ExternalID>TEST0002</ExternalID>
    <SKU>TEST0002</SKU>
    <Quantity>100</Quantity>
    <WarehouseID>523</WarehouseID>
    <ClientID>580</ClientID>
  </Inventory>
</Inventories>
```

--------------------------------

### Specifying Project Analysis in Zynk Purchase Orders (XML)

Source: https://docs.zynk.com/workflow/developers/sage-200/purchase-order-xml_q=

This example shows how to include project analysis information for purchase order items in Zynk. The 'ProjectRef' and 'ProjectItem' must exist in Sage 200. 'ProjectItem' can include a hierarchy using forward slashes.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Company 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PurchaseOrders>
    <PurchaseOrder>
      <PurchaseOrderItems>
        <Item>
          <ProjectRef>0000000001</ProjectRef>
          <ProjectItem>MATERIAL01</ProjectItem>
        </Item>
      </PurchaseOrderItems>
    </PurchaseOrder>
  </PurchaseOrders>
</Company>
```

--------------------------------

### XML Examples for Client Matching

Source: https://docs.zynk.com/workflow/developers/mintsoft/order_q=

These examples demonstrate how to match a client record using different criteria: ID, Code, Name, and ShortName. The default matching is by ID. Providing a value for MatchClientOn determines which client identifier to use.

```XML
<ClientID>1</ClientID>
```

```XML
<MatchClientOn>Code</MatchClientOn>
<Client>
    <Code>CLIE0001</Code>
</Client>
```

```XML
<MatchClientOn>Name</MatchClientOn>
<Client>
    <Name>Client Example 1</Name>
</Client>
```

```XML
<MatchClientOn>ShortName</MatchClientOn>
<Client>
    <ShortName>Client 1</ShortName>
</Client>
```

--------------------------------

### GET /orders/{order_id}/coupons

Source: https://docs.zynk.com/workflow/documentation/bigcommerce-v3/export-orders

Retrieves a list of coupons applied to a specific order.

```APIDOC
## GET /orders/{order_id}/coupons

### Description
Retrieves a list of coupons that have been applied to a specific order.

### Method
GET

### Endpoint
/orders/{order_id}/coupons

### Parameters
#### Path Parameters
- **order_id** (integer) - Required - The unique identifier of the order.

### Request Example
```
GET /stores/v5k4i/v2/orders/104/coupons
```

### Response
#### Success Response (200)
(This endpoint may return an empty list if no coupons were applied.)

#### Response Example
```json
[]
```
```

--------------------------------

### Sample XML Output from Zynk Project

Source: https://docs.zynk.com/workflow/documentation/amazon-marketplace/export-products

This XML snippet represents a sample output file from the Zynk project. It details the results of matching products from the input file. Each 'MatchingProduct' entry includes the original ID, ID type, a status (Success or ClientError), and marketplace information. For successful matches, product attributes are included; for errors, an error message is provided.

```xml
<?xml version="1.0" encoding="utf-8"?>
<MatchingProducts>
  <MatchingProduct Id="B07M7P1SQF" IdType="ASIN" Status="Success" MarketplaceId="A1F83G8C2ARO7P" MarketplaceName="Amazon.co.uk">
    <Products>
      <Product xmlns="http://mws.amazonservices.com/schema/Products/2011-10-01">
        <Identifiers>
          <MarketplaceASIN>
            <MarketplaceId>A1F83G8C2ARO7P</MarketplaceId>
            <ASIN>B07M7P1SQF</ASIN>
          </MarketplaceASIN>
        </Identifiers>
        <AttributeSets>
          <ns2:ItemAttributes xml:lang="en-GB" xmlns:ns2="http://mws.amazonservices.com/schema/Products/2011-10-01/default.xsd">
            <ns2:Binding>Misc.</ns2:Binding>
            <ns2:Brand>Artistic Colour Gloss</ns2:Brand>
            <ns2:Label>Artistic Colour Gloss</ns2:Label>
            <ns2:Manufacturer>Artistic Colour Gloss</ns2:Manufacturer>
            <ns2:ProductGroup>Beauty</ns2:ProductGroup>
            <ns2:ProductTypeName>BEAUTY</ns2:ProductTypeName>
            <ns2:Publisher>Artistic Colour Gloss</ns2:Publisher>
            <ns2:SmallImage>
              <ns2:URL>http://ecx.images-amazon.com/images/I/41BeRvC82wL._SL75_.jpg</ns2:URL>
              <ns2:Height Units="pixels">75</ns2:Height>
              <ns2:Width Units="pixels">75</ns2:Width>
            </ns2:SmallImage>
            <ns2:Studio>Artistic Colour Gloss</ns2:Studio>
            <ns2:Title>Crave The Rave 2018 Gel Polish Collection - Dance All Night (2100181) 15ml</ns2:Title>
          </ns2:ItemAttributes>
        </AttributeSets>
        <Relationships />
        <SalesRankings />
      </Product>
    </Products>
  </MatchingProduct>
  <MatchingProduct Id="814799025607" IdType="EAN" Status="ClientError" MarketplaceId="A1F83G8C2ARO7P" MarketplaceName="Amazon.co.uk">
    <Error xmlns="http://mws.amazonservices.com/schema/Products/2011-10-01">
      <Type>Sender</Type>
      <Code>InvalidParameterValue</Code>
      <Message>Invalid EAN identifier 814799025607 for marketplace A1F83G8C2ARO7P</Message>
    </Error>
  </MatchingProduct>
  <MatchingProduct Id="9781933988665" IdType="ISBN" Status="Success" MarketplaceId="A1F83G8C2ARO7P" MarketplaceName="Amazon.co.uk">
    <Products>
      <Product xmlns="http://mws.amazonservices.com/schema/Products/2011-10-01">
        <Identifiers>
          <MarketplaceASIN>
            <MarketplaceId>A1F83G8C2ARO7P</MarketplaceId>
            <ASIN>1933988665</ASIN>
          </MarketplaceASIN>
        </Identifiers>
        <AttributeSets>
          <ns2:ItemAttributes xml:lang="en-GB" xmlns:ns2="http://mws.amazonservices.com/schema/Products/2011-10-01/default.xsd">
            <ns2:Author>Haralambos Marmanis</ns2:Author>
            <ns2:Author>Dmitry Babenko</ns2:Author>
            <ns2:Binding>Paperback</ns2:Binding>
            <ns2:Edition>1</ns2:Edition>
            <ns2:ItemDimensions>
              <ns2:Height Units="inches">9.25</ns2:Height>
              <ns2:Length Units="inches">7.38</ns2:Length>
              <ns2:Width Units="inches">0.73</ns2:Width>
              <ns2:Weight Units="pounds">1.3800937601200</ns2:Weight>
            </ns2:ItemDimensions>
            <ns2:IsAdultProduct>false</ns2:IsAdultProduct>
            <ns2:Label>Manning Publications</ns2:Label>
            <ns2:Languages>
              <ns2:Language>
                <ns2:Name>english</ns2:Name>
                <ns2:Type>Published</ns2:Type>
              </ns2:Language>
              <ns2:Language>
                <ns2:Name>english</ns2:Name>
                <ns2:Type>Original Language</ns2:Type>
              </ns2:Language>
              <ns2:Language>
                <ns2:Name>english</ns2:Name>
                <ns2:Type>Unknown</ns2:Type>
              </ns2:Language>
            </ns2:Languages>
            <ns2:ListPrice>
              <ns2:Amount>28.99</ns2:Amount>
              <ns2:CurrencyCode>GBP</ns2:CurrencyCode>
            </ns2:ListPrice>
            <ns2:Manufacturer>Manning Publications</ns2:Manufacturer>
            <ns2:NumberOfItems>1</ns2:NumberOfItems>
            <ns2:NumberOfPages>368</ns2:NumberOfPages>
            <ns2:PackageDimensions>
              <ns2:Height Units="inches">0.799999999184000</ns2:Height>
              <ns2:Length Units="inches">9.099999990718000</ns2:Length>
              <ns2:Width Units="inches">7.299999992554000</ns2:Width>
              <ns2:Weight Units="pounds">1.35</ns2:Weight>
            </ns2:PackageDimensions>
            <ns2:PackageQuantity>1</ns2:PackageQuantity>
            <ns2:ProductGroup>Book</ns2:ProductGroup>
            <ns2:ProductTypeName>ABIS_BOOK</ns2:ProductTypeName>
            <ns2:PublicationDate>2009-07-08</ns2:PublicationDate>

```

--------------------------------

### GET /orders/{order_id}/shippingaddresses

Source: https://docs.zynk.com/workflow/documentation/bigcommerce-v3/export-orders

Retrieves the shipping addresses associated with a specific order.

```APIDOC
## GET /orders/{order_id}/shippingaddresses

### Description
Retrieves the shipping addresses associated with a specific order. This includes details like name, company, and address lines.

### Method
GET

### Endpoint
/orders/{order_id}/shippingaddresses

### Parameters
#### Path Parameters
- **order_id** (integer) - Required - The unique identifier of the order.

### Request Example
```
GET /stores/v5k4i/v2/orders/104/shippingaddresses
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the shipping address.
- **first_name** (string) - The first name of the recipient.
- **last_name** (string) - The last name of the recipient.
- **street_1** (string) - The first line of the street address.
- **city** (string) - The city of the shipping address.
- **state** (string) - The state or province of the shipping address.
- **zip** (string) - The postal zip code.
- **country** (string) - The country of the shipping address.

#### Response Example
```json
{
  "id": 5,
  "first_name": "Joe",
  "last_name": "Blogs",
  "company": "Zynk Software Limited",
  "street_1": "6-8 Charlotte Square",
  "street_2": "i6",
  "city": "Newcastle upon-Tyne",
  "state": "Tyne and Wear",
  "zip": "NE1 4XF",
  "country": "United Kingdom",
  "country_iso2": "GB",
  "phone": "0845 123 2920",
  "email": null,
  "form_fields": []
}
```
```

--------------------------------

### Sample Product Data in XML

Source: https://docs.zynk.com/workflow/documentation/magento-v2/export-products

This XML snippet represents a sample product output from the Zynk project. It includes detailed information about a product, such as its ID, SKU, name, pricing, status, and custom attributes like description and color. The structure also accommodates product links and options.

```xml
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfProduct xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Product>
    <id>1</id>
    <sku>24-MB01</sku>
    <name>Joust Duffle Bag</name>
    <created_at>2016-02-01T10:57:52</created_at>
    <updated_at>2016-04-07T08:45:54</updated_at>
    <store_id xsi:nil="true" />
    <attribute_set_id>15</attribute_set_id>
    <price>34</price>
    <status>1</status>
    <visibility>4</visibility>
    <type_id>simple</type_id>
    <weight xsi:nil="true" />
    <product_links>
      <product_link>
        <sku>24-MB01</sku>
        <link_type>upsell</link_type>
        <linked_product_sku>24-MB03</linked_product_sku>
        <linked_product_type>simple</linked_product_type>
        <position xsi:nil="true" />
        <extension_attributes />
      </product_link>
      <product_link>
        <sku>24-MB01</sku>
        <link_type>upsell</link_type>
        <linked_product_sku>24-MB05</linked_product_sku>
        <linked_product_type>simple</linked_product_type>
        <position xsi:nil="true" />
        <extension_attributes />
      </product_link>
    </product_links>
    <options />
    <tier_prices />
    <custom_attributes>
      <custom_attribute>
        <attribute_code>description</attribute_code>
        <value><p>The sporty Joust Duffle Bag can't be beat - not in the gym, not on the luggage carousel, not anywhere. Big enough to haul a basketball or soccer ball and some sneakers with plenty of room to spare, it's ideal for athletes with places to go.<p>
<ul>
<li>Dual top handles.</li>
<li>Adjustable shoulder strap.</li>
<li>Full-length zipper.</li>
<li>L 29" x W 13" x H 11".</li>
</ul></value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>color</attribute_code>
        <value>49</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>options_container</attribute_code>
        <value>container2</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>required_options</attribute_code>
        <value>0</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>has_options</attribute_code>
        <value>0</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>url_key</attribute_code>
        <value>joust-duffle-bag</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>tax_class_id</attribute_code>
        <value>2</value>
      </custom_attribute>
      <custom_attribute>
        <attribute_code>activity</attribute_code>
        <value>11,22,21,19</value>
      </custom_attribute>
    </custom_attributes>
  </Product>
</ArrayOfProduct>
```

--------------------------------

### Sage Intacct Product Import XML Example

Source: https://docs.zynk.com/workflow/developers/sage-intacct/item-xml_q=

A comprehensive XML example demonstrating the structure for importing a new item into Sage Intacct, including various fields for general, advanced, and matching information.

```xml
<?xml version="1.0" encoding="utf-8"?>
<ITEMS>
    <ITEM>
        <EXTERNALID>2944512</EXTERNALID>
        <ITEMIDENTIFIER>Sellotape</ITEMIDENTIFIER>
        <NAME>Full roll of sellotape</NAME>
        <BASEPRICE>0.99</BASEPRICE>
        <NOTE>Non-perishable</NOTE>
        <PODESCRIPTION>Full roll of sellotape</PODESCRIPTION>
        <SODESCRIPTION>Full roll of sellotape</SODESCRIPTION>
        <SHIP_WEIGHT>0.02</SHIP_WEIGHT>
        <STANDARDCOST>0.49</STANDARDCOST>
        <TAXABLE>true</TAXABLE>
        <UOMGRP>Each</UOMGRP>
        <UPC>SELLO01</UPC>
    </ITEM>
</ITEMS>
```

--------------------------------

### Example Output

Source: https://docs.zynk.com/workflow/documentation/connectwise/export-billing-cycles

A sample XML output file for exported billing cycles.

```APIDOC
## Example Output

```xml
<?xml version="1.0" encoding="utf-8"?>
<BillingCycles xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <BillingCycle>
    <id>1</id>
    <externalId />
    <_info>
      <dateEntered>2004-07-08T13:58:35Z</dateEntered>
      <enteredBy>CONVERSION</enteredBy>
      <lastUpdated>2004-07-08T13:58:35Z</lastUpdated>
      <updatedBy>zadmin</updatedBy>
    </_info>
    <identifier>B</identifier>
    <name>Bi-Monthly</name>
    <defaultFlag>false</defaultFlag>
    <billingOptions>BiMonthly</billingOptions>
  </BillingCycle>
</BillingCycles>
```
```

--------------------------------

### XML Purchase Order Data Example

Source: https://docs.zynk.com/workflow/documentation/magnetichq/export-purchase-orders

This snippet displays a sample XML output file representing purchase order data. It includes details about the account, company, and owner associated with the purchase order. The structure is hierarchical, with nested elements for each piece of information.

```xml
<?xml version="1.0" encoding="utf-8"?>
<MagneticHQData xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Error />
  <PurchaseOrders>
    <PurchaseOrder>
      <Account>
        <Id>137623827</Id>
        <Version>0</Version>
        <Name>Test</Name>
        <RefCode>PO-0004</RefCode>
        <Status>DRAFT</Status>
        <Description />
        <PaymentTerms>30 Days</PaymentTerms>
        <Billed>0.0</Billed>
        <Tax>20.0</Tax>
        <Cost>10.0</Cost>
        <CurrencyCost>10.0</CurrencyCost>
        <Margin>0.0</Margin>
        <CurrencyMargin>0.0</CurrencyMargin>
        <TotalCost>12.0</TotalCost>
        <CurrencyTotalCost>12.0</CurrencyTotalCost>
        <CreatedDate>1501653600000</CreatedDate>
        <IssuedDate>0</IssuedDate>
        <Company>
          <Id>136271987</Id>
          <Version>1</Version>
          <Name>TestCompany</Name>
          <ContactPerson />
          <BillingName />
          <ContactNumber />
          <EmailAddress />
          <PhysicalAddress />
          <PostalAddress />
          <Website />
          <MailDomain />
          <Description />
          <CreatedDate>1500384746834</CreatedDate>
          <OtherInfo />
          <ExternalReference />
          <Tag />
          <TaxNumber />
          <KeyPerson>
            <Id>137623819</Id>
            <Version>1</Version>
            <Title />
            <FirstName>ContactNameTest</FirstName>
            <LastName />
            <FullName>ContactNameTest </FullName>
            <LandNumber />
            <CellNumber />
            <FaxNumber />
            <Email />
            <PhysicalAddress />
            <PostalAddress />
            <Position />
            <OtherInfo />
            <ExternalReference />
            <Tag />
            <CreatedDate>1501688201524</CreatedDate>
            <Owner>
              <Id>53090727</Id>
              <Version>202</Version>
              <Title>Studio Manager</Title>
              <FirstName>Oliver</FirstName>
              <LastName>Jeffery</LastName>
              <FullName>Oliver Jeffery</FullName>
              <Email>magnetic@email.co.uk</Email>
              <ContactNumber>07123456789</ContactNumber>
              <Description />
              <UserName>magnetic@email.co.uk</UserName>
              <RoleType>ADMIN</RoleType>
              <UserManager>true</UserManager>
              <Skin>bing</Skin>
              <Accounts>true</Accounts>
              <Grouping>Design</Grouping>
              <CreatedDate>1446813531845</CreatedDate>
              <LastAccessedDate>1503566378222</LastAccessedDate>
              <LoginAttempts>0</LoginAttempts>
              <TimeTrackingUser>false</TimeTrackingUser>
              <NoWorkDone>1446731581084</NoWorkDone>
              <PageSize>40</PageSize>
              <Status>ACTIVATED</Status>
              <AccountsAdministrator>true</AccountsAdministrator>
              <AddGroupings>true</AddGroupings>
              <NotifyMethod>EMAIL</NotifyMethod>
              <HrManager>true</HrManager>
              <TimeZone>36,GMT+02:00</TimeZone>
              <ReceiveDailyNotification>false</ReceiveDailyNotification>
              <ReceiveRealtimeNotifications>true</ReceiveRealtimeNotifications>
              <HideDetails>false</HideDetails>
              <TaskView>LIST</TaskView>
              <GroupingSignedView>STATUSLANE</GroupingSignedView>
              <GroupingUnsignedView>LIST</GroupingUnsignedView>
              <Type>SALES</Type>
              <RewardStatus>NONE</RewardStatus>
              <AnnualLeave>26</AnnualLeave>
              <SickLeave>0</SickLeave>
              <CompassionateLeave>0</CompassionateLeave>
              <OtherLeave>0</OtherLeave>
              <ReceiveHrEmails>true</ReceiveHrEmails>
              <HourCapacityPerDay>8.0</HourCapacityPerDay>
              <EmployeeCost>0.0</EmployeeCost>
              <CostEstimatePermission>WRITE_APPROVE</CostEstimatePermission>
              <PurchaseOrderPermission>WRITE</PurchaseOrderPermission>
              <TaxInvoicePermission>WRITE</TaxInvoicePermission>
              <SupplierInvoicePermission>WRITE</SupplierInvoicePermission>
              <ExpensePermission>NONE</ExpensePermission>
              <Active>true</Active>
              <FirstLastInitial>Oliver J</FirstLastInitial>
            </Owner>
            <Global>true</Global>
            <CustomFields />
          </KeyPerson>
          <Owner>
            <Id>53090727</Id>
            <Version>202</Version>
            <Title>Studio Manager</Title>
            <FirstName>Oliver</FirstName>
            <LastName>Jeffery</LastName>
            <FullName>Oliver Jeffery</FullName>
            <Email>magnetic@email.co.uk</Email>
            <ContactNumber>07123456789</ContactNumber>
            <Description />
            <UserName>magnetic@email.co.uk</UserName>

```

--------------------------------

### GraphQL Selections Example for Exporting Order Data

Source: https://docs.zynk.com/workflow/documentation/shopify/graph-ql/selections-syntax_q=

This example demonstrates the complete GraphQL Selections syntax for exporting order information from Shopify. It includes selecting fields, nested objects like billingAddress, connections like lineItems, and unions like purchasingEntity.

```graphql
{
  id
  name
  createdAt
  updatedAt
  billingAddress {
    address1
    address2
    city
    countryCodeV2
    firstName
    lastName
    zip
  }
  lineItems (first: 100) {
    nodes {
      id
      name
      quantity
      sku
    }
  }
  purchasingEntity {
    __typename
    ... on Customer {
      id
      email
      firstName
      lastName
    }
    ... on PurchasingCompany {
      company {
        id
        name
        externalId
      }
    }
  }
}
```

--------------------------------

### XML Product Data Structure Example

Source: https://docs.zynk.com/workflow/documentation/shopify/graph-ql/import-products

This XML snippet demonstrates the structure of product data, including details about categories, collections, variants, and metafields. It serves as a sample input for processing within the Zynk system.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Products xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Product>
    <Category>
      <Id>gid:// જynk/TaxonomyCategory/ap-2-1</Id>
      <FullName>Animals &amp; Pet Supplies &gt; Pet Supplies &gt; Bird Supplies</FullName>
      <Name>Bird Supplies</Name>
    </Category>
    <ClaimOwnership>
      <Bundles>false</Bundles>
    </ClaimOwnership>
    <Collections>
      <Record>
        <Id>gid:// જynk/Collection/94099996761</Id>
        <Title>Summer 2025</Title>
      </Record>
    </Collections>
    <CombinedListingRole>PARENT</CombinedListingRole>
    <DescriptionHtml>A wooden bird feeder</DescriptionHtml>
    <GiftCardTemplateSuffix>default</GiftCardTemplateSuffix>
    <Handle>bird-feeder</Handle>
    <IsGiftCard>false</IsGiftCard>
    <Metafields>
      <Record>
        <Key>product_sku</Key>
        <Namespace>custom</Namespace>
        <Value>BF0001</Value>
      </Record>
    </Metafields>
    <Options>
      <Option>
        <Name>Colour</Name>
        <Position>1</Position>
        <Values>
          <Value>Red</Value>
          <Value>Yellow</Value>
          <Value>Blue</Value>
        </Values>
      </Option>
    </Options>
    <ProductType>Garden</ProductType>
    <RedirectNewHandle>false</RedirectNewHandle>
    <RequiresSellingPlan>false</RequiresSellingPlan>
    <Seo>
      <Description>A wooden bird feeder</Description>
      <Title>Bird feeder</Title>
    </Seo>
    <Status>ACTIVE</Status>
    <Tags>
      <Tag>garden</Tag>
    </Tags>
    <TemplateSuffix>default</TemplateSuffix>
    <Title>Bird Feeder</Title>
    <Variants>
      <Record>
        <Barcode>12345678910</Barcode>
        <CompareAtPrice>10.00</CompareAtPrice>
        <Id>gid:// જynk/ProductVariant/42309202509913</Id>
        <InventoryItem>
          <CountryCodeOfOrigin>GB</CountryCodeOfOrigin>
          <HarmonizedSystemCode>12345678</HarmonizedSystemCode>
          <Measurement>
            <Weight>
              <Unit>KILOGRAMS</Unit>
              <Value>0.25</Value>
            </Weight>
          </Measurement>
          <RequiresShipping>true</RequiresShipping>
          <Sku>BF0001-RED</Sku>
          <Tracked>true</Tracked>
          <UnitCost>
            <Amount>4.00</Amount>
          </UnitCost>
        </InventoryItem>
        <InventoryPolicy>DENY</InventoryPolicy>
        <InventoryQuantities>
            <InventoryQuantity>
              <LocationId>gid:// જynk/Location/16144367705</LocationId>
              <LocationName>6-8 Charlotte Square</LocationName>
              <Name>on_hand</Name>
              <Quantity>6</Quantity>
            </InventoryQuantity>
        </InventoryQuantities>
        <Metafields>
          <Record>
            <Key>large_item</Key>
            <Namespace>custom</Namespace>
            <Value>false</Value>
          </Record>
        </Metafields>
        <OptionValues>
          <OptionValue>
            <Name>Red</Name>
            <OptionName>Colour</OptionName>
          </OptionValue>
        </OptionValues>
        <Position>1</Position>
        <Price>8.00</Price>
        <RequiresComponents>false</RequiresComponents>
        <Sku>BF0001-RED</Sku>
        <Taxable>true</Taxable>
        <TaxCode>T1</TaxCode>
      </Record>
      <Record>
        <OptionValues>
          <OptionValue>
            <Name>Yellow</Name>
            <OptionName>Colour</OptionName>
          </OptionValue>
        </OptionValues>
        <Position>2</Position>
        <Price>8.00</Price>
        <Sku>BF0001-YELLOW</Sku>
        <Taxable>true</Taxable>
      </Record>
      <Record>
        <OptionValues>
          <OptionValue>
            <Name>Blue</Name>
            <OptionName>Colour</OptionName>
          </OptionValue>
        </OptionValues>
        <Position>3</Position>
        <Price>8.00</Price>
        <Sku>BF0001-BLUE</Sku>
        <Taxable>true</Taxable>
      </Record>
    </Variants>
    <Vendor>Zynk</Vendor>
  </Product>
</Products>
```

--------------------------------

### Home Address Import

Source: https://docs.zynk.com/workflow/developers/act/contact-xml

This section details how to import home address information for contacts. It maps ACT! fields to XML fields and provides examples.

```APIDOC
## Home Address Import

### Description
This endpoint allows for the import of home address details for contacts. It specifies the mapping between ACT! fields and their corresponding XML fields, along with data types and input constraints.

### Method
POST

### Endpoint
/websites/zynk/address

### Parameters
#### Request Body
- **Address1** (string) - Optional - The first line of the address.
- **Address2** (string) - Optional - The second line of the address.
- **Address3** (string) - Optional - The third line of the address (not visible in default layout).
- **Town** (string) - Optional - The city or town.
- **County** (string) - Optional - The county. Values are matched case-insensitively against ACT! list values.
- **Postcode** (string) - Optional - The postal code.
- **Country** (string) - Optional - The ISO2 country code.
- **Telephone** (string) - Optional - The home phone number.

### Request Example
```json
{
  "Address1": "Newcastle Enterprise Centres",
  "Address2": "6 Charlotte Square",
  "Address3": "",
  "Town": "Newcastle upon Tyne",
  "County": "Tyne and Wear",
  "Postcode": "NE1 4XF",
  "Country": "GB",
  "Telephone": "0845 123 2920"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - Provides details about the import process.

#### Response Example
```json
{
  "status": "success",
  "message": "Home address imported successfully."
}
```
```

--------------------------------

### Activity Management

Source: https://docs.zynk.com/workflow/developers/act/contact-xml_q=

This endpoint facilitates the import of activities against contact records. It includes details such as activity name, description, start date, end date, and activity type.

```APIDOC
## POST /websites/zynk/activities

### Description
Imports activities against contact records. Warnings are logged for failed imports.

### Method
POST

### Endpoint
/websites/zynk/activities

### Parameters
#### Request Body
- **Regarding** (string) - Optional - The name or subject of the activity. Matched case-insensitively against ACT! list values.
- **Details** (string) - Optional - Detailed description of the activity.
- **StartDate** (date) - Required - The start date of the activity (YYYY-MM-DD). Must be on or after 01/01/1900. Defaults to EndDate if not provided.
- **EndDate** (date) - Required - The end date of the activity (YYYY-MM-DD). Must be on or after 01/01/1900. Defaults to StartDate if not provided.
- **ActivityType** (enum) - Optional - The type of activity. Defaults to 'Call'. Valid values: Call, Meeting, ToDo.

### Request Example
```json
{
  "Regarding": "Follow-up Call",
  "Details": "Discuss project proposal.",
  "StartDate": "2024-08-26",
  "EndDate": "2024-08-26",
  "ActivityType": "Call"
}
```

### Response
#### Success Response (200)
- **status** (string) - Indicates the success of the operation.
- **message** (string) - A confirmation message.

#### Response Example
```json
{
  "status": "success",
  "message": "Activity imported successfully."
}
```
```

--------------------------------

### Sample XML Input for Zynk Project

Source: https://docs.zynk.com/workflow/documentation/amazon-marketplace/export-products

This XML snippet represents a sample input file for the Zynk project. It contains a list of products, each identified by an 'Id' and 'IdType' attribute (e.g., ASIN, EAN, ISBN). This data is used to query product information.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Products>
  <Product Id="B07M7P1SQF" IdType="ASIN" />
  <Product Id="814799025607" IdType="EAN" />
  <Product Id="9781933988665" IdType="ISBN" />
</Products>
```

--------------------------------

### XML Order and Shipment Data Example

Source: https://docs.zynk.com/workflow/documentation/amazon-vendor-central-v2/export-direct-fulfilment-orders

This XML snippet represents a sample output file containing detailed order information. It includes purchase order numbers, order status, shipment details like priority and delivery dates, tax information, party details (selling, shipping, billing), and itemized product information with quantities and pricing. This structure is commonly used for data exchange and integration purposes.

```xml
<?xml version="1.0" encoding="utf-8"?>
<Orders xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <Order>
    <PurchaseOrderNumber>2JK3S9VC</PurchaseOrderNumber>
    <OrderDetails>
      <OrderStatus>NEW</OrderStatus>
      <CustomerOrderNumber>123-ABC</CustomerOrderNumber>
      <OrderDate>2020-02-20T13:51:00Z</OrderDate>
      <ShipmentDetails>
        <IsPriorityShipment>false</IsPriorityShipment>
        <IsScheduledDeliveryShipment>false</IsScheduledDeliveryShipment>
        <IsPslipRequired>true</IsPslipRequired>
        <IsGift>false</IsGift>
        <ShipMethod>UPS_2ND</ShipMethod>
        <ShipmentDates>
          <RequiredShipDate>2020-02-21T00:00:00Z</RequiredShipDate>
          <PromisedDeliveryDate>2020-02-24T00:00:00Z</PromisedDeliveryDate>
        </ShipmentDates>
        <MessageToCustomer>This shipment completes your order. You can always check the status of your orders from the "Your Account" link at the top of each page of our site. Thank you for shopping at Amazon.com</MessageToCustomer>
      </ShipmentDetails>
      <TaxTotal>
        <TaxLineItems>
          <TaxLineItem>
            <Type>TOTAL</Type>
            <TaxRate>0.1</TaxRate>
            <TaxAmount>
              <CurrencyCode>USD</CurrencyCode>
              <Amount>190</Amount>
            </TaxAmount>
          </TaxLineItem>
        </TaxLineItems>
      </TaxTotal>
      <SellingParty>
        <PartyId>999US</PartyId>
      </SellingParty>
      <ShipFromParty>
        <PartyId>ABCD</PartyId>
      </ShipFromParty>
      <ShipToParty>
        <Name>John Doe</Name>
        <Attention>John Doe</Attention>
        <AddressLine1>123 Any Street</AddressLine1>
        <AddressLine2>Apt 5</AddressLine2>
        <AddressLine3 />
        <City>Any Town</City>
        <County />
        <District />
        <StateOrRegion>CA</StateOrRegion>
        <PostalCode>94086</PostalCode>
        <CountryCode>USA</CountryCode>
        <Phone />
      </ShipToParty>
      <BillToParty>
        <PartyId>ABCD</PartyId>
      </BillToParty>
      <Items>
        <Item>
          <ItemSequenceNumber>00001</ItemSequenceNumber>
          <BuyerProductIdentifier>B07DFVDRAB</BuyerProductIdentifier>
          <VendorProductIdentifier>8806098286500</VendorProductIdentifier>
          <Title>LG 8 kg Inverter Wi-Fi Fully-Automatic Front Loading Washing Machine (FHT1408SWS, STS-VCM, Inbuilt Heater)</Title>
          <OrderedQuantity>
            <UnitOfMeasure>EACH</UnitOfMeasure>
            <Amount>1</Amount>
          </OrderedQuantity>
          <NetPrice>
            <CurrencyCode>USD</CurrencyCode>
            <Amount>500</Amount>
          </NetPrice>
          <TaxDetails>
            <TaxLineItems>
              <TaxLineItem>
                <Type>TOTAL</Type>
                <TaxRate>0.1</TaxRate>
                <TaxAmount>
                  <CurrencyCode>USD</CurrencyCode>
                  <Amount>50</Amount>
                </TaxAmount>
              </TaxLineItem>
            </TaxLineItems>
          </TaxDetails>
          <BuyerCustomizedInfo>
            <CustomizedUrl>aHR0cHM6Ly8xcC1kZi1wdWJsaWMtZGF0YS5zMy5hbWF6b25hd3MuY29tLzExMS0xMjYwNzQ1LTYyOTE0MTZfNTgzNjIxNTQwMTM1NjEuemlw</CustomizedUrl>
          </BuyerCustomizedInfo>
        </Item>
        <Item>
          <ItemSequenceNumber>2</ItemSequenceNumber>
          <BuyerProductIdentifier>B07DFYF5AB</BuyerProductIdentifier>
          <VendorProductIdentifier>8806098286123</VendorProductIdentifier>
          <Title>LG 6.5 kg Inverter Fully-Automatic Front Loading Washing Machine (FHT1065SNW, Blue and White, Inbuilt Heater)</Title>
          <OrderedQuantity>
            <UnitOfMeasure>EACH</UnitOfMeasure>
            <Amount>2</Amount>
          </OrderedQuantity>
          <NetPrice>
            <CurrencyCode>USD</CurrencyCode>
            <Amount>700</Amount>
          </NetPrice>
          <TaxDetails>
            <TaxLineItems>
              <TaxLineItem>
                <Type>TOTAL</Type>
                <TaxRate>0.1</TaxRate>
                <TaxAmount>
                  <CurrencyCode>USD</CurrencyCode>
                  <Amount>140</Amount>
                </TaxAmount>
              </TaxLineItem>
            </TaxLineItems>
          </TaxDetails>
        </Item>
      </Items>
    </OrderDetails>
  </Order>
</Orders>
```

--------------------------------

### Xero Item XML: Purchase Details

Source: https://docs.zynk.com/workflow/developers/xero/item-xml_q=

This XML example shows how to define purchase details for an inventory item, including Unit Price, COGSAccountCode, TaxRate, and Purchases Description.

```xml
<?xml version="1.0"?>
<ArrayOfXeroItem>
  <XeroItem>
    <PurchaseDetails>
      <UnitPrice>2.00</UnitPrice>
      <COGSAccountCode>300</COGSAccountCode>
      <TaxType>INPUT2</TaxType>
    </PurchaseDetails>
    <PurchaseDescription>1000 sheets of A4 paper</PurchaseDescription>
  </XeroItem>
</ArrayOfXeroItem>

```
Tokens:
Raw