Superfiliate

Create or update order

Bearer authorders.writeAlpha
Alpha: This endpoint is available only to approved API integrations and may change without notice.

Persists an order from a custom commerce integration. Repeating the request with the same external_id updates the existing order for the authenticated shop.

subtotal_value, total_value, and line-item amounts must be decimal strings. The subtotal is the amount after discounts and before shipping and taxes. external_created_at must be the authoritative timestamp from the commerce platform.

The customer is found or created from the normalized customer_email. A line item requires a stable external_id, display name, positive integer quantity, and subtotal after discounts. Gross unit price, product and variant IDs, and SKU are optional, but integrations should provide them when product-level attribution or reporting is required.

This endpoint persists the normalized order. Paid orders are eligible for conversion processing, which uses a matching storefront event when one exists.

POSTapi.superfiliate.com/api/v1/orders

Body parametersapplication/json

  • external_idstringrequired

    Identifier for the related external.

  • statusenum<string>required

    Shopify financial status

    "pending""paid"

  • currencyenum<string>required

    ISO 4217 currency code

    "AED""AFN""ALL""AMD""ANG""AOA""ARS""AUD""AWG""AZN""BAM""BBD""BDT""BGN""BHD""BIF""BMD""BND""BOB""BRL""BSD""BTN""BWP""BYN""BYR""BZD""CAD""CDF""CHF""CLF""CLP""CNY""COP""CRC""CUC""CUP""CVE""CZK""DJF""DKK""DOP""DZD""EEK""EGP""ERN""ETB""EUR""FJD""FKP""GBP""GEL""GHS""GIP""GMD""GNF""GTQ""GYD""HKD""HNL""HRK""HTG""HUF""IDR""ILS""INR""IQD""IRR""ISK""JMD""JOD""JPY""KES""KGS""KHR""KMF""KPW""KRW""KWD""KYD""KZT""LAK""LBP""LKR""LRD""LSL""LTL""LVL""LYD""MAD""MDL""MGA""MKD""MMK""MNT""MOP""MRO""MRU""MTL""MUR""MVR""MWK""MXN""MYR""MZN""NAD""NGN""NIO""NOK""NPR""NZD""OMR""PAB""PEN""PGK""PHP""PKR""PLN""PYG""QAR""RON""RSD""RUB""RWF""SAR""SBD""SCR""SDG""SEK""SGD""SHP""SKK""SLE""SLL""SOS""SRD""SSP""STD""STN""SVC""SYP""SZL""THB""TJS""TMM""TMT""TND""TOP""TRY""TTD""TWD""TZS""UAH""UGX""USD""UYU""UZS""VEF""VES""VND""VUV""WST""XAF""XAG""XAU""XBA""XBB""XBC""XBD""XCD""XDR""XOF""XPD""XPF""XPT""XTS""YER""ZAR""ZMK""ZMW""ZWD""ZWL""ZWN""ZWR"

  • customer_emailstringrequired

    The customer email for this resource.

  • subtotal_valuestringrequired

    Amount after discounts and before shipping and taxes

  • total_valuestringrequired

    Final order amount

  • discount_codestring | null

    Attribution or promotional discount code applied to the order

  • external_created_atstringrequired

    Authoritative order creation timestamp

  • The line items for this resource.

    • external_idstringrequired

      Identifier for the related external.

    • external_product_idstring | null

      Identifier for the related external product.

    • external_variant_idstring | null

      Identifier for the related external variant.

    • namestringrequired

      Human-readable name for this resource.

    • skustring | null

      The sku for this resource.

    • quantityintegerrequired

      The quantity for this resource.

    • gross_unit_pricestring | null

      The gross unit price for this resource.

    • discount_totalstring | null

      The discount total for this resource.

    • subtotal_pricestringrequired

      The subtotal price for this resource.

Responses

Order created or updated

  • idinteger
  • external_idstring

    Identifier for the related external.

  • statusenum<string>

    Current status of this resource.

    "pending""paid"

  • currencystring

    The currency for this resource.

  • customer_emailstring

    The customer email for this resource.

  • subtotal_valuestring

    The subtotal value for this resource.

  • total_valuestring

    The total value for this resource.

  • discount_codestring | null

    Code for discount.

  • external_created_atstring

    ISO 8601 timestamp for external created.

  • The line items for this resource.

    • external_idstring

      Identifier for the related external.

    • external_product_idstring | null

      Identifier for the related external product.

    • external_variant_idstring | null

      Identifier for the related external variant.

    • namestring

      Human-readable name for this resource.

    • skustring | null

      The sku for this resource.

    • quantityinteger

      The quantity for this resource.

    • gross_unit_pricestring | null

      The gross unit price for this resource.

    • discount_totalstring | null

      The discount total for this resource.

    • subtotal_pricestring

      The subtotal price for this resource.