native_integration

Collection: native_integrations

A native integration represents a third party system natively integrated with Foxy which requires configuration settings and credentials.

Currently supported native integrations include Avalara, TaxJar, ONESOURCE, Webhook, and Custom Tax.

Notes

The config property is a JSON string whose structure depends on the provider value:

Avalara config properties:

  • service_url: Your Avalara Service URL. Use https://development.avalara.net for test mode or https://avatax.avalara.net for production.
  • id: Your Avalara Account Number.
  • key: Your Avalara License Key.
  • company_code: The Company Code configured in your Avalara Account.
  • use_ava_tax: (Boolean) true or false to use Avalara for live tax rates.
  • enable_colorado_delivery_fee: (Boolean) true or false to enable the Colorado Delivery Fee.
  • create_invoice: (Boolean) true or false. Commit details to Avalara as a Committed Sales Invoice after each transaction.
  • use_address_validation: (Boolean) true or false. Validate customer addresses prior to completing the transaction.
  • address_validation_countries: An array of country codes. Currently supports US and CA only.
  • category_to_product_tax_code_mappings: An object mapping Foxy category codes to AvaTax tax codes.

TaxJar config properties:

  • api_token: Your SmartCalcs API Token from TaxJar.
  • category_to_product_tax_code_mappings: (JSON) Mapping of Foxy category codes to TaxJar product tax codes.
  • create_invoice: (Boolean) true or false. Commit transaction details to TaxJar.

ONESOURCE config properties:

  • service_url: The ONESOURCE service URL.
  • external_company_id: Required external company ID.
  • calling_system_number: Unique identifier for your ERP system.
  • from_city: City matching your configured postal code and country.
  • host_system: Unique name for your ERP system.
  • company_role: Role in transaction: Buyer (B), Middleman (M), or Seller (S).
  • part_number_product_option: Custom product option name for part number (e.g., sku, isbn, or code).
  • product_order_priority: Comma-separated list of FoxyCart category codes for product listing order.
  • audit_settings: Values include capture_only, auth_and_capture, and never.

Webhook config properties:

  • service: Can be json, legacy_xml, webflow, or zapier.
  • For json service: title, encryption_key, url, events (array), version (integer).
  • For legacy_xml service: title, url, events (array), version (integer).
  • For webflow service: site_id, site_name, collection_id, collection_name, sku_field_id, sku_field_name, inventory_field_id, inventory_field_name, auth, events (array), version (integer).
  • zapier service types are read only and must be created from zapier.com.

Custom Tax config properties:

  • url: The Custom Tax service URL for adding taxes to checkout.

Required Scopes

Full store_full_access
Read webhooks_read
Write webhooks_write

Actions

GET View a native integration
PATCH Update a native integration (send only the properties you want to modify)
PUT Replace a native integration (send the entire representation)
DELETE Delete a native integration
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (4)

provider String · Required

The identifier string of this provider.

avalarataxjaronesourcewebhookcustom_tax
config String · Required · max 1000

A JSON string containing the configuration values and credentials for this native integration.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (3)

self This Native Integration
fx:store GET PATCH PUT DELETE This Store
fx:taxes GET POST Taxes using this Native Integration as the service provider.

Only present when the native integration is associated with a tax service provider (e.g., Avalara).

https://api.foxycart.com/native_integrations/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/native_integrations/123",
      "title": "This Native Integration"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    }
  },
  "provider": "avalara",
  "config": "{\"service_url\":\"https://development.avalara.net/\",\"id\":\"12345678\",\"key\":\"ASDFJASDFKJASDFKJ\",\"company_code\":\"CompanyCode\",\"use_ava_tax\":true,\"create_invoice\":true,\"use_address_validation\":false,\"address_validation_countries\":[],\"category_to_product_tax_code_mappings\":{\"1005\":\"PS081258\"}}",
  "date_created": "2016-03-24T11:02:40-0700",
  "date_modified": "2016-03-31T12:15:41-0700"
}