Products

Create a supplier offer

Create a tenant-scoped supplier offer for a product or one of its variants.

post/companies/{company}/products/{product}/supplier-offers

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/products/{product}/supplier-offers
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

productstring uuid required

Public identifier (UUID v7) of the product.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

supplier_idstring uuid required
variant_idstring uuid nullable
supplier_skustring nullable
purchase_unit'C62' | 'KGM' | 'GRM' | 'LTR' | 'MLT' | 'MTR' | 'MTK' | 'HUR' | 'DAY' | 'H87' | 'XPK' | 'XBX' | 'XDS' | 'XBG' | 'XBO' | 'XDJ' | 'XCA' | 'XTB' | 'XCI' | 'XJY' | 'XEN' | 'XCS' required
conversion_factornumber required
unit_costnumber nullable
availability'available' | 'unavailable' | 'unknown' | 'seasonal' | 'store_dependent' required
minimum_quantitynumber nullable
lead_time_daysinteger nullable
preferredboolean
activeboolean

Response

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8b20",
    "object": "supplier_product_offer",
    "product_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a09",
    "supplier_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a02",
    "variant_id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8b22",
    "supplier_sku": "BOD-RIOJA-SUP",
    "purchase_unit": "LTR",
    "conversion_factor": "1.000000",
    "unit_cost": "2.40",
    "currency": "EUR",
    "availability": "in_stock",
    "minimum_quantity": "50.0000",
    "lead_time_days": 3,
    "preferred": true,
    "active": true
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.