Skip to main content

Create Integration Instance

POST 
//:domain/api/walmart

Create a new Walmart integration instance. After creation, automatically fetches an access token, dispatches jobs to download locations, and refresh products and orders.

Authentication: Requires Bearer token.

Fields:

  • name (required, string, unique): Human-readable name for this integration instance
  • integration_id (required, integer): ID of the Walmart integration type
  • environment (optional, string): Walmart environment — sandbox or production. Ignored on production servers (always forced to production). Defaults to sandbox on non-production servers. Immutable after creation — OAuth credentials are bound to the issuing environment. To switch, delete and recreate the instance.
  • connection_settings.clientId (optional, string): Walmart API client ID
  • connection_settings.clientSecret (optional, string): Walmart API client secret
  • integration_settings.start_date (required, string): Date to start syncing orders/products from (YYYY-MM-DD)
  • integration_settings.store_id (required, integer): Internal store ID to associate with
  • integration_settings.auto_link_products (required, boolean): Automatically link Walmart products to SKU products
  • integration_settings.auto_create_products (required, boolean): Automatically create SKU products from Walmart products
  • integration_settings.sales_nominal_code_id (nullable, integer): Nominal code ID for sales accounting
  • integration_settings.cogs_nominal_code_id (nullable, integer): Nominal code ID for cost of goods sold
  • integration_settings.shipping_revenue_nominal_code_id (nullable, integer): Nominal code ID for shipping revenue
  • integration_settings.shipping_refund_nominal_code_id (nullable, integer): Nominal code ID for shipping refunds
  • integration_settings.sales_returns_allowances_nominal_code_id (nullable, integer): Nominal code ID for returns
  • integration_settings.sync_sales_order_invoices_to_accounting (boolean, default true): Sync invoices to accounting
  • integration_settings.sync_sales_credit_to_accounting (boolean, default true): Sync credits to accounting
  • integration_settings.proforma_marketplace_cost_percentage (nullable, float): Marketplace cost percentage
  • integration_settings.proforma_payment_cost_percentage (nullable, float): Payment cost percentage
  • integration_settings.batch_period_sales_order_fulfillments (nullable, string): Batch period override for fulfillments
  • integration_settings.batch_period_customer_returns (nullable, string): Batch period override for customer returns
  • is_automatic_sync_enabled (boolean, default false): Enable automatic synchronization

Request​

Responses​

Created

Response Headers
    Content-Type