Tax of Record API

Overview

Outpost Tax of Record provides a REST API that automates tax registration, calculation, and filings while you maintain your own checkout and payment service providers (Stripe, Adyen, etc.). The integration is server-to-server — your frontend never calls Outpost directly.

Build with AI

Copy the full integration brief and paste it into your AI coding assistant to scaffold the integration automatically.

One-click brief for your AI agent.

Integration Flow

Frontend→Your Backend→Outpost API

Frontend initiates checkout and calls your backend
Your backend authenticates with Outpost using OAuth2 client_credentials
Backend calculates tax via Outpost API and displays it at checkout
After payment succeeds, backend stores the transaction with Outpost
Outpost handles all tax filing, compliance, and liability

Security & Operational Principles

Server-only secrets — OUTPOST_CLIENT_SECRET must never be exposed to browsers or logs
Token management — Cache access tokens with TTL, refresh on expiry or 401 responses
Idempotency — Prevent double confirm/cancel calls using merchantTransactionReference tracking
Timeouts & retries — 5s timeout per request, retry transient errors (network/5xx) with bounded backoff
Production gates — Store calls only after PSP authorization/capture succeeds

Environment Setup

Variable	Value	Notes
API_BASE_URL	https://api.outpostanywhere.com	Base URL for all API endpoints
CLIENT_ID	Your client ID	Non-sensitive, can be inlined
OUTPOST_CLIENT_SECRET	—	Store in environment variables or secret manager

Authentication

Outpost uses OAuth2 client_credentials flow for server-to-server authentication. Your backend requests an access token using your client ID and secret, then includes it as a Bearer token in all API calls.

Flow

Request access token using client credentials
Parse response and extract access_token with expires_in
Cache token server-side with TTL (recommend expires_in - 300s buffer)
Refresh token on expiry or 401 responses
Include Bearer token in all subsequent API requests

Cache access_token with expires_in - 300s buffer; retry once after refresh on 401.

Token Response

{
  "access_token": "<JWT>",
  "expires_in": 86400,
  "token_type": "Bearer"
}

Authentication

# Step 1: Obtain an access token
curl -X POST \
  "https://access.outpostanywhere.com/oauth2/token" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "grant_type=client_credentials" \
  -d "client_id=YOUR_CLIENT_ID" \
  -d "client_secret=$OUTPOST_CLIENT_SECRET" | jq

# Export the token (example)
# export OUTPOST_ACCESS_TOKEN="eyJhbGciOi..."

# Sample response:
# {
#   "access_token": "<JWT>",
#   "expires_in": 86400,
#   "token_type": "Bearer"
# }

Run from your server. Never expose secrets in the browser.

Create Tax Calculation

POST/api/tax/calculations

Creates a tax calculation for a given set of line items and customer information. The calculation determines applicable tax rates based on the customer's location and can be used to create a transaction after the successful payment.

Request Headers

Parameter	Type	Required	Description
Authorization	—	Yes	Bearer token for authentication
Content-Type	—	Yes	application/json

Request Body

{
  "currency": "EUR",
  "taxBehavior": "EXCLUSIVE",
  "customer": {
    "merchantCustomerReference": "CUST-12345",
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "taxIdentifiers": [
      {
        "type": "EU_VAT",
        "code": "NL123456789B01"
      }
    ],
    "billingAddress": {
      "line1": "Keizersgracht 123",
      "line2": "Apt 4B",
      "city": "Amsterdam",
      "postalCode": "1015 CJ",
      "country": "NL"
    }
  },
  "lineItems": [
    {
      "merchantLineItemReference": "ITEM-001",
      "productCode": "TEST-SKU-005",
      "description": "Premium Subscription - Annual",
      "unitPrice": 99.99,
      "quantity": 1,
      "discountAmount": 10.00
    }
  ],
  "evidence": {
    "billingCountry": "NL",
    "ipAddress": "185.23.108.42",
    "paymentMethodCountry": "NL"
  }
}

Request Body Parameters

Parameter	Type	Required	Description
currency	string	Yes	ISO 4217 currency code (e.g., EUR, USD, GBP, BRL). Brazil B2C NFS-e requires BRL.
taxBehavior	string enum	No	Allowed values: EXCLUSIVE, INCLUSIVE. Defaults to EXCLUSIVE. Brazil B2C NFS-e requires INCLUSIVE; see Brazil notes for country-specific amount behavior.
customer	object	Yes	Customer information object
customer.merchantCustomerReference	string	No	Your internal customer identifier
customer.firstName	string	Conditional	Customer's first name. Required for Brazil B2C NFS-e.
customer.lastName	string	Conditional	Customer's last name. Required for Brazil B2C NFS-e.
customer.email	string	No	Customer's email address
customer.taxIdentifiers	array	Conditional	Customer tax identifiers, discriminated on type. Required for Brazil NFS-e calculations.
customer.taxIdentifiers[].type	string enum	Conditional	Identifier type: BR_CPF, BR_CNPJ, EU_VAT, GB_VAT, or US_EIN. The jurisdiction is part of the type — there is no country field. Unknown types are rejected. For Brazil B2C NFS-e, use BR_CPF.
customer.taxIdentifiers[].code	string	Conditional	Identifier value. Validated per type: check digits for BR_CPF and BR_CNPJ, VIES format with a two-letter country prefix for EU_VAT. GB_VAT and US_EIN are informational and recorded as provided.
customer.taxIdentifiers[].buyerTaxRegime	string enum	Conditional	BR_CNPJ only. Allowed values: SIMPLES_NACIONAL, LUCRO_PRESUMIDO, LUCRO_REAL. Required for Brazil B2B NFS-e calculations.
customer.billingAddress	object	Yes	Customer's billing address
customer.billingAddress.line1	string	Yes	Primary address line
customer.billingAddress.line2	string	No	Secondary address line
customer.billingAddress.city	string	Yes	City name
customer.billingAddress.state	string	Conditional	State/province code (required for US and CA)
customer.billingAddress.postalCode	string	Yes	Postal/ZIP code
customer.billingAddress.country	string	Yes	ISO 3166-1 alpha-2 country code
customer.shippingAddress	object	No	Customer's shipping address. Recommended for physical goods — the destination drives US sales-tax sourcing.
customer.shippingAddress.line1	string	No	Primary address line
customer.shippingAddress.line2	string	No	Secondary address line
customer.shippingAddress.city	string	No	City name
customer.shippingAddress.state	string	Conditional	State/province code (required for US and CA)
customer.shippingAddress.postalCode	string	No	Postal/ZIP code
customer.shippingAddress.country	string	No	ISO 3166-1 alpha-2 country code
lineItems	array	Yes	Array of line items (minimum 1)
lineItems[].merchantLineItemReference	string	Yes	Your internal line item identifier
lineItems[].productCode	string	Yes	Product/service code for tax classification
lineItems[].description	string	Yes	Human-readable item description
lineItems[].unitPrice	decimal	Yes	Price per unit (must be ≥ 0)
lineItems[].quantity	integer	No	Quantity (default: 1, must be > 0)
lineItems[].discountAmount	decimal	No	Discount amount per unit. For quantity 3 and discountAmount 2.00, the total discount is 6.00; applied before tax calculation.
evidence	object	Conditional	Tax evidence (required for non-US/non-BR billing addresses; optional for Brazil)
evidence.billingCountry	string	Conditional	ISO 3166-1 alpha-2 billing country code. Required for non-US/non-BR evidence; if provided for Brazil, must be BR.
evidence.ipAddress	string	Conditional	Customer's IP address. Required for non-US/non-BR billing addresses; optional for Brazil.
evidence.paymentMethodCountry	string	No	Payment method country code

Note: For non-US/non-BR billing addresses, evidence is required and evidence.billingCountry must match customer.billingAddress.country. For Brazil, evidence can be omitted; if provided, evidence.billingCountry must be BR and evidence.ipAddress is optional.

Brazil B2C NFS-e: use currency BRL, include customer first and last name, include exactly one valid BR_CPF identifier in customer.taxIdentifiers and set taxBehavior to INCLUSIVE when the submitted line amount should remain the service value and ISS tax base.

Response 201 Created

{
  "taxCalculationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "createdAt": "2026-01-05T12:00:00Z",
  "expiresAt": "2026-01-05T12:30:00Z",
  "currency": "EUR",
  "subTotalAmount": "99.99",
  "discountAmount": "10.00",
  "netAmount": "89.99",
  "taxAmount": "18.90",
  "totalAmount": "108.89",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "billingAddress": {
      "line1": "Keizersgracht 123",
      "line2": "Apt 4B",
      "city": "Amsterdam",
      "postalCode": "1015 CJ",
      "country": "NL"
    }
  },
  "lineItems": [
    {
      "lineItemId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "merchantLineItemReference": "ITEM-001",
      "productCode": "TEST-SKU-005",
      "description": "Premium Subscription - Annual",
      "unitPrice": "99.99",
      "quantity": 1,
      "discountAmount": "10.00",
      "itemSubTotalAmount": "99.99",
      "itemNetAmount": "89.99",
      "itemTotalAmount": "108.89",
      "tax": {
        "rate": "21.00",
        "taxAmount": "18.90",
        "currency": "EUR"
      },
      "refunded": false
    }
  ],
  "evidence": {
    "billingCountry": "NL",
    "ipAddress": "185.23.108.42",
    "paymentMethodCountry": "NL"
  },
  "entity": {
    "companyName": "Outpost Commerce B.V."
  }
}

Brazil B2C NFS-e Example

Brazil B2C NFS-e calculations require BRL, customer first and last name, and a BR_CPF tax identifier. In inclusive mode, the submitted line amount remains the service value and ISS tax base; tax is not backed out of the line amount. The response keeps unit price, subtotal, net amount, and total amount at the submitted amount and reports ISS separately.

{
  "currency": "BRL",
  "taxBehavior": "INCLUSIVE",
  "customer": {
    "merchantCustomerReference": "BR-CUST-001",
    "firstName": "Beatriz",
    "lastName": "Costa",
    "email": "beatriz.costa@example.com",
    "taxIdentifiers": [
      {
        "type": "BR_CPF",
        "code": "<VALID_CUSTOMER_CPF>"
      }
    ],
    "billingAddress": {
      "line1": "Rua Oscar Freire, 900",
      "city": "Sao Paulo",
      "state": "SP",
      "postalCode": "01426-002",
      "country": "BR"
    }
  },
  "lineItems": [
    {
      "merchantLineItemReference": "BR-VAS-ITEM-001",
      "productCode": "BR-VAS-001",
      "description": "Value-added mobile service",
      "unitPrice": 49.90,
      "quantity": 1
    }
  ],
  "evidence": {
    "billingCountry": "BR",
    "ipAddress": "200.160.2.3",
    "paymentMethodCountry": "BR"
  }
}

{
  "taxCalculationId": "019ef95a-cc77-78da-9041-58908baabaf9",
  "createdAt": "2026-01-05T12:00:00Z",
  "expiresAt": "2026-01-05T12:30:00Z",
  "currency": "BRL",
  "subTotalAmount": "49.90",
  "discountAmount": "0.00",
  "netAmount": "49.90",
  "taxAmount": "1.45",
  "totalAmount": "49.90",
  "customer": {
    "firstName": "Beatriz",
    "lastName": "Costa",
    "email": "beatriz.costa@example.com",
    "billingAddress": {
      "line1": "Rua Oscar Freire, 900",
      "city": "Sao Paulo",
      "state": "SP",
      "postalCode": "01426-002",
      "country": "BR"
    }
  },
  "lineItems": [
    {
      "lineItemId": "83e026ae-b270-4590-926a-03b286fc84d8",
      "merchantLineItemReference": "BR-VAS-ITEM-001",
      "productCode": "BR-VAS-001",
      "description": "Value-added mobile service",
      "unitPrice": "49.90",
      "quantity": 1,
      "discountAmount": "0.00",
      "itemSubTotalAmount": "49.90",
      "itemNetAmount": "49.90",
      "itemTotalAmount": "49.90",
      "tax": {
        "rate": "2.90",
        "taxAmount": "1.45",
        "currency": "BRL"
      }
    }
  ],
  "evidence": {
    "billingCountry": "BR",
    "ipAddress": "200.160.2.3",
    "paymentMethodCountry": "BR"
  },
  "entity": {
    "companyName": "Outpost Brazil Limitada"
  }
}

Brazil CPF Validation Error

If the tax identifier is missing, has a type other than BR_CPF, or fails CPF check-digit validation, the calculation request is rejected before tax is calculated.

{
  "code": "invalid_argument",
  "errors": [
    {
      "field": "customer.taxIdentifiers[0].code",
      "message": "must be a valid CPF"
    }
  ]
}

Response Fields

Parameter	Type	Required	Description
taxCalculationId	string	—	Unique identifier for the calculation
createdAt	string	—	ISO 8601 timestamp when calculation was created
expiresAt	string	—	ISO 8601 timestamp when calculation expires
currency	string	—	Currency code
subTotalAmount	decimal	—	Sum of line item amounts before discounts
discountAmount	decimal	—	Total discount amount applied
netAmount	decimal	—	Amount after discounts, before tax
taxAmount	decimal	—	Total tax amount
totalAmount	decimal	—	Final amount including tax
customer	object	—	Customer information
lineItems	array	—	Calculated line items with tax details
evidence	object	—	Tax evidence used for calculation
entity	object	—	The Outpost legal entity acting as seller / merchant of record (present when Tax of Record applies).
entity.companyName	string	—	Legal company name of the recording entity.

Amount and rate fields in responses are returned as decimal strings to preserve precision. Request examples may send decimal values as JSON numbers.

Error Responses

HTTP	Code	Description
400	invalid_argument	Missing or invalid field — check field requirements
400	invalid_state	Please activate Outpost Tax of Record to process transactions
409	region_not_activated	Merchant not activated for the customer's tax jurisdiction
409	region_not_supported	Customer location outside supported jurisdictions
409	integration_not_configured	Tax compliance integration is not configured
401	—	Invalid or missing Authorization token

Code Example

# Step 2: Calculate tax for the transaction
curl -X POST "https://api.outpostanywhere.com/api/tax/calculations" \
  -H "Authorization: Bearer $OUTPOST_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "currency": "EUR",
    "taxBehavior": "EXCLUSIVE",
    "customer": {
      "merchantCustomerReference": "CUST-001",
      "firstName": "John",
      "lastName": "Doe",
      "email": "john.doe@example.com",
      "billingAddress": {
        "line1": "123 Main St",
        "city": "Berlin",
        "postalCode": "10115",
        "country": "DE"
      }
    },
    "lineItems": [
      {
        "merchantLineItemReference": "ITEM-001",
        "productCode": "SKU-123",
        "description": "Sample Product",
        "unitPrice": 19.99,
        "quantity": 1
      }
    ],
    "evidence": {
      "billingCountry": "DE",
      "ipAddress": "192.168.1.1",
      "paymentMethodCountry": "DE"
    }
  }' | jq

# Response: 201 Created with taxCalculationId
# Save the taxCalculationId for the Store step

Create Tax Transaction

POST/api/tax/transactions

Converts a valid tax calculation into a confirmed tax transaction. This endpoint should be called when an order is finalized/paid. Only call after payment authorization/capture succeeds.

Request Headers

Parameter	Type	Required	Description
Authorization	—	Yes	Bearer token for authentication
Content-Type	—	Yes	application/json

Request Body

{
  "taxCalculationId": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
  "merchantTransactionReference": "ORDER-2026-001234",
  "payment": {
    "processor": "stripe",
    "paymentReference": "ch_3Q1234567890abcdef"
  }
}

Request Body Parameters

Parameter	Type	Required	Description
taxCalculationId	string	Yes	ID of the tax calculation generated by Outpost to convert
merchantTransactionReference	string	Yes	Your unique order/transaction reference
payment	object	No	Payment processor information
payment.processor	string	No	Payment processor name (e.g., "stripe", "adyen")
payment.paymentReference	string	No	Payment processor transaction ID

Response 200 OK

{
  "transactionId": "e83a9c47-2b5d-4f8a-9c12-3d4e5f6a7b8c",
  "refunded": false,
  "createdAt": "2026-01-05T12:05:00Z",
  "confirmedAt": "2026-01-05T12:05:00Z",
  "currency": "EUR",
  "subTotalAmount": "99.99",
  "discountAmount": "10.00",
  "netAmount": "89.99",
  "taxAmount": "18.90",
  "totalAmount": "108.89",
  "merchantTransactionReference": "ORDER-2026-001234",
  "transactionDate": "2026-01-05T12:05:00Z",
  "customer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com",
    "billingAddress": {
      "line1": "Keizersgracht 123",
      "line2": "Apt 4B",
      "city": "Amsterdam",
      "postalCode": "1015 CJ",
      "country": "NL"
    }
  },
  "payment": {
    "processor": "stripe",
    "paymentReference": "ch_3Q1234567890abcdef"
  },
  "refundsOnTransaction": [],
  "lineItems": [
    {
      "lineItemId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "merchantLineItemReference": "ITEM-001",
      "productCode": "TEST-SKU-005",
      "description": "Premium Subscription - Annual",
      "unitPrice": "99.99",
      "quantity": 1,
      "discountAmount": "10.00",
      "itemSubTotalAmount": "99.99",
      "itemNetAmount": "89.99",
      "itemTotalAmount": "108.89",
      "tax": {
        "rate": "21.00",
        "taxAmount": "18.90",
        "currency": "EUR"
      },
      "refunded": false
    }
  ],
  "evidence": {
    "billingCountry": "NL",
    "ipAddress": "185.23.108.42",
    "paymentMethodCountry": "NL"
  }
}

Error Responses

HTTP	Code	Description
400	invalid_argument	Missing or invalid field — check field requirements
400	invalid_state	Tax calculation has expired
400	invalid_state	Tax calculation has already been used
400	invalid_state	Tax transactions API can only be used for Tax of Record product
404	not_found	Tax calculation not found

Code Example

# Step 3: Store the transaction using taxCalculationId from calculate response
curl -X POST "https://api.outpostanywhere.com/api/tax/transactions" \
  -H "Authorization: Bearer $OUTPOST_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "taxCalculationId": "'"$TAX_CALCULATION_ID"'",
    "merchantTransactionReference": "TXN-001",
    "payment": {
      "paymentReference": "PAY-001",
      "processor": "stripe"
    }
  }' | jq

# Response: 200 OK with TaxTransactionResponse

Get Tax Transaction

GET/api/tax/transactions/{transaction_id}

Retrieves the details of an existing tax transaction.

Path Parameters

Parameter	Type	Required	Description
transaction_id	string	Yes	ID of the transaction

Response 200 OK

Returns a TaxTransactionResponse object (same structure as Create Tax Transaction response).

Error Responses

HTTP	Code	Description
404	not_found	Transaction not found

Get Transaction Refunds

GET/api/tax/transactions/{transaction_id}/refunds

Retrieves all refunds associated with a transaction.

Path Parameters

Parameter	Type	Required	Description
transaction_id	string	Yes	ID of the original transaction

Response 200 OK

[
  {
    "refundTransactionId": "d1e2f3a4-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
    "merchantRefundReference": "REFUND-2026-000456",
    "refundDate": "2026-01-10T15:30:00Z",
    "refundLineItems": [
      {
        "lineItemId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
        "refundLineItemReference": "REFUND-ITEM-001",
        "refundReason": "Customer requested cancellation",
        "refundItemSubTotalAmount": "99.99",
        "refundItemTotalAmount": "108.89",
        "refundTax": {
          "rate": "21.00",
          "taxAmount": "18.90",
          "currency": "EUR"
        }
      }
    ],
    "createdAt": "2026-01-10T15:30:00Z",
    "currency": "EUR",
    "subTotalAmount": "99.99",
    "taxAmount": "18.90",
    "totalAmount": "108.89"
  }
]

Error Responses

HTTP	Code	Description
404	not_found	Transaction not found

Create Refund Transaction

POST/api/tax/transactions/{transaction_id}/refunds

Creates a refund for one or more line items in an existing transaction.

Path Parameters

Parameter	Type	Required	Description
transaction_id	string	Yes	ID of the original transaction

Request Body

{
  "merchantRefundReference": "REFUND-2026-000456",
  "refundDate": "2026-01-10T15:30:00Z",
  "refundLineItems": [
    {
      "lineItemId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "refundLineItemReference": "REFUND-ITEM-001",
      "refundReason": "Customer requested cancellation"
    }
  ]
}

Request Body Parameters

Parameter	Type	Required	Description
merchantRefundReference	string	Yes	Your unique refund reference
refundDate	string	No	ISO 8601 date/time of the refund
refundLineItems	array	Yes	Array of line items to refund (minimum 1)
refundLineItems[].lineItemId	string	Yes	ID of the original line item
refundLineItems[].refundLineItemReference	string	Yes	Your unique reference for this refund item
refundLineItems[].refundReason	string	Yes	Reason for the refund

Response 200 OK

{
  "refundTransactionId": "d1e2f3a4-5b6c-7d8e-9f0a-1b2c3d4e5f6a",
  "merchantRefundReference": "REFUND-2026-000456",
  "refundDate": "2026-01-10T15:30:00Z",
  "refundLineItems": [
    {
      "lineItemId": "a1b2c3d4-5678-90ab-cdef-1234567890ab",
      "refundLineItemReference": "REFUND-ITEM-001",
      "refundReason": "Customer requested cancellation",
      "refundItemSubTotalAmount": "99.99",
      "refundItemTotalAmount": "108.89",
      "refundTax": {
        "rate": "21.00",
        "taxAmount": "18.90",
        "currency": "EUR"
      }
    }
  ],
  "createdAt": "2026-01-10T15:30:00Z",
  "currency": "EUR",
  "subTotalAmount": "99.99",
  "taxAmount": "18.90",
  "totalAmount": "108.89"
}

Error Responses

HTTP	Code	Description
404	not_found	Transaction or line items not found

Get Transaction Invoice

GET/api/tax/transactions/{transaction_id}/invoice

Retrieves the invoice file for a transaction.

Path Parameters

Parameter	Type	Required	Description
transaction_id	string	Yes	ID of the transaction

Response 200 OK

{
  "b2cInvoice": {
    "fileName": "invoice-e83a9c47-2b5d-4f8a-9c12-3d4e5f6a7b8c.pdf",
    "url": "https://storage.outpostnow.com/invoices/..."
  }
}

Response Fields

Parameter	Type	Required	Description
b2cInvoice	object	—	B2C invoice information
b2cInvoice.fileName	string	—	Name of the invoice file
b2cInvoice.url	string	—	URL to download the invoice

Response 202 Accepted — Invoice is still being generated. Retry after a short delay.

Import Catalogue Product

POST/api/catalogue/products

Imports a single product variant into your catalogue for tax classification. Each call imports one variant. To model a product that comes in multiple options (size, colour, plan tier), send one request per variant and group them under a shared parent product.

Request Headers

Parameter	Type	Required	Description
Authorization	—	Yes	Bearer token for authentication
Content-Type	—	Yes	application/json

Request Body

{
  "productId": "TSHIRT-001-M",
  "productGroupId": "TSHIRT-001",
  "title": "Classic T-Shirt",
  "requiresShipping": true,
  "taxable": true,
  "description": "100% cotton crew-neck t-shirt",
  "category": "Apparel",
  "imageUrl": "https://cdn.example.com/tshirt-001.png",
  "sku": "TSHIRT-001-M",
  "hsCode": "6109.10",
  "countryOfOrigin": "PT",
  "priceAmount": 24.99,
  "priceCurrency": "USD"
}

Request Body Parameters

Parameter	Type	Required	Description
productId	string	Yes	Unique identifier for this variant (the sellable unit). Used as the variant key.
productGroupId	string	No	Parent product identifier. Share across variants to group them under one product. Defaults to productId (standalone) when omitted.
title	string	Yes	Product title. Product-level — keep identical across variants of a group.
requiresShipping	boolean	Yes	Whether the item ships physically.
taxable	boolean	No	Whether the item is taxable (default: true).
description	string	No	Product description. Product-level.
category	string	No	Product category / type. Product-level.
imageUrl	string	No	Product image URL. Product-level.
sku	string	No	Stock keeping unit. Variant-level.
hsCode	string	No	Harmonized System code for customs. Variant-level.
countryOfOrigin	string	No	ISO 3166-1 alpha-2 country of origin. Variant-level.
priceAmount	decimal	No	Unit price (default: 0). Variant-level.
priceCurrency	string	No	ISO 4217 currency code (default: USD). Variant-level.

Response 201 Created

{
  "productId": "TSHIRT-001-M",
  "productGroupId": "TSHIRT-001",
  "title": "Classic T-Shirt",
  "requiresShipping": true,
  "status": "IMPORTED",
  "approvedTaxCode": null,
  "predictedTaxCode": null
}

Response Fields

Parameter	Type	Required	Description
productId	string	—	The variant identifier you supplied.
productGroupId	string \| null	—	Parent product id. null when the product is its own group (standalone).
title	string	—	Product title.
requiresShipping	boolean	—	Whether the item ships physically.
status	string	—	Classification status: IMPORTED, EXTRACTED, READY_FOR_CLASSIFICATION, APPROVED, or ARCHIVED. A fresh import returns IMPORTED.
approvedTaxCode	string \| null	—	Operator-approved tax code. null until a tax code is approved.
predictedTaxCode	string \| null	—	Classifier-predicted tax code. null until classification runs.

Product grouping

Two fields control grouping: productId identifies the variant (the sellable unit), and productGroupId identifies the parent product. There are two ways to structure a product:

Standalone product — omit productGroupId. The variant becomes its own group and the response returns productGroupId as null. Use this for single-option items such as an eBook or a one-off SKU.
Multi-variant product — send several requests that share one productGroupId, each with a distinct productId. Every call attaches one variant to the same parent product — for example group TSHIRT-001 with variants TSHIRT-001-S, TSHIRT-001-M and TSHIRT-001-L.

Standalone product example:

{
  "productId": "EBOOK-101",
  "title": "Tax Compliance Handbook (eBook)",
  "requiresShipping": false,
  "priceAmount": 9.99,
  "priceCurrency": "USD"
}

Product-level vs variant-level fields

Product-level (title, description, category, imageUrl) is keyed by the group. Keep these identical across all variants of one group.
Variant-level (sku, priceAmount, priceCurrency, taxable, requiresShipping, hsCode, countryOfOrigin) is specific to each variant.

Re-importing

Re-sending a variant with identical content is a no-op.
Changing title or description while the variant is APPROVED clears the approval and returns the variant to READY_FOR_CLASSIFICATION for re-review.
Changing only priceAmount, hsCode or countryOfOrigin updates the variant silently and keeps any approval.
Importing a new productId under an existing productGroupId adds a variant. Tax codes are not inherited; each variant is classified and approved on its own.

Classification lifecycle

The status field moves through IMPORTED → EXTRACTED → READY_FOR_CLASSIFICATION → APPROVED → ARCHIVED. predictedTaxCode is set by the classifier after import; approvedTaxCode is set when an operator approves. A fresh import returns IMPORTED with both codes null.

Note: catalogue tax codes are operator-facing today. Tax calculations do not automatically resolve a stored approvedTaxCode; tax is still determined per line item at calculation time.

Error Responses

HTTP	Code	Description
400	validation_error	Missing required field — productId, title, or requiresShipping
401	—	Invalid or missing Authorization token
409	—	Conflict — the product could not be imported in its current state

Code Example

# Import a product variant into the catalogue
curl -X POST "https://api.outpostanywhere.com/api/catalogue/products" \
  -H "Authorization: Bearer $OUTPOST_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "productId": "TSHIRT-001-M",
    "productGroupId": "TSHIRT-001",
    "title": "Classic T-Shirt",
    "requiresShipping": true,
    "sku": "TSHIRT-001-M",
    "priceAmount": 24.99,
    "priceCurrency": "USD"
  }' | jq

# Response: 201 Created with the product status and tax codes
# Omit productGroupId to import a standalone product

Integration Flow

The full checkout integration follows a linear sequence: authenticate, calculate tax, process payment, then store the transaction.

Sequence

Get/refresh access token (cache with TTL)
Calculate tax → capture taxCalculationId
Process payment with your PSP (Stripe, Adyen, etc.)
If payment succeeds → Call Store with taxCalculationId and payment details

Pseudocode

async function processCheckout(orderData) {
  // Step 1: Get auth token
  const token = await getAccessToken();

  // Step 2: Calculate tax
  const taxResponse = await calculateTax(orderData, token);
  const taxCalculationId = taxResponse.taxCalculationId;

  // Persist mapping for idempotency
  await persistCalculationMapping(orderData.orderId, taxCalculationId);

  // Step 3: Process payment with your PSP
  const paymentResult = await processPayment(orderData, taxResponse.taxTotal);

  // Step 4: Store transaction only if payment succeeds
  if (paymentResult.success) {
    await storeTransaction({
      taxCalculationId,
      merchantTransactionReference: orderData.orderId,
      payment: {
        paymentReference: paymentResult.paymentReference,
        processor: paymentResult.processor  // e.g., "stripe", "adyen"
      }
    }, token);
  }

  return { success: paymentResult.success, taxResponse };
}

Idempotency Controls

Store merchantTransactionReference → taxCalculationId mappings
Check existing mappings before creating new calculations
Implement mutex/locks for concurrent order processing
Use database constraints to prevent duplicate transactions
The merchantTransactionReference in Store prevents duplicate storage

Error Handling

Classify errors by HTTP status code and handle them accordingly. Never retry 4xx errors blindly — they indicate client-side issues that need to be fixed.

4xx — Client Errors

Do not retry blindly.

401 — Refresh token and retry once
400 — Log and fail fast (likely data validation issue)
404 — Calculation not found (check taxCalculationId when calling Store)

5xx — Server Errors

Temporary failures, safe to retry.

Safe to retry with exponential backoff
Max 3 retries with 1s, 2s, 4s delays
Include jitter to prevent thundering herd

Token Refresh on 401

// On 401 response:
// 1. Clear cached token
// 2. Request new access token
// 3. Retry the original request once with new token
// 4. If still 401, fail and alert

Structured Logging

{
  "timestamp": "2024-01-15T10:30:00Z",
  "level": "INFO",
  "message": "Tax calculated",
  "orderId": "order-12345",
  "taxCalculationId": "calc-67890",
  "currency": "USD",
  "taxAmount": 8.25,
  "requestId": "req-uuid-123",
  "duration": 1200
}

Metrics & Alerting

Success rates — Percentage of successful calculate/store operations
Latency — P95/P99 response times for each endpoint
Error rates — 4xx vs 5xx error breakdown by endpoint
Token refresh frequency — Monitor auth token lifecycle

Alert Conditions

Success rate drops below 95%
P95 latency exceeds 2 seconds
5xx error rate exceeds 1%
Store rate significantly lower than calculate rate
Token refresh failures

Testing & Rollout

Follow a phased rollout strategy to minimize risk. Start with calculate-only mode, then gradually enable store calls as you gain confidence.

Sandbox Testing

Authentication

Verify token acquisition and refresh

Calculate

Test with various customer/product scenarios

Store

Test successful payment flow with valid taxCalculationId

Error handling

Test timeout, retry, and 4xx/5xx scenarios

Rollout Strategy

Phase 1Calculate only (store disabled) to test tax calculation

Phase 2Enable Store for 1% of successful payments

Phase 3Gradually increase to 10%, 50%, 100%

RollbackFeature flags to disable Store calls quickly if needed

Acceptance Checklist

Auth token acquisition works

Token caching and refresh logic implemented

Calculate returns valid taxCalculationId

taxCalculationId properly stored with order

Store includes payment details (paymentReference, processor)

Store only called after successful payment

Timeout and retry logic implemented

Error handling covers 4xx and 5xx cases

Logging includes correlation IDs

Monitoring and alerting configured

Ready to integrate?

Copy the complete integration plan for your AI coding assistant, or contact us for white-glove onboarding.

One-click brief for your AI agent.