Skip to content

Commerce Orbit storefront API

Read the shop, products and collections, run a cart, check out and show the order from your own website.

The storefront API lets your own website show products with live prices and stock, run a cart and take orders. It needs no key: it returns what the hosted shop shows anyway, and payments go straight from the shopper's browser to the shop's own Stripe account. A key is optional: it counts your requests, and a secret key also reads draft products for a preview.

Answers are JSON. A successful answer has the result in data; an error has error, with a code and a message you can show to shoppers. Amounts are whole minor units in the currency given.

Any website may read the shop, products and collections from a browser. Carts, checkout, orders, returns and customer accounts answer only the shop's Website and Allowed websites in Settings, and servers.

Requests are limited per network (IP address), with no rate-limit headers: reading the shop, products and collections allows 120 a minute for each shop, and each other endpoint names its own limit on its 429 answer, which has the code rate_limited. Wait a minute before trying again.

Read the guideOpenAPI 3.1 document

Try it settings

https://app.bifrostorbit.com/commerce/api/public

The catalogue needs no key. A public key (com_pk_) from API keys in Commerce Orbit counts your requests.

Try it sends each request straight from your browser to the API. The key stays in this page's memory: it is never saved, never sent to docs.bifrostorbit.com and gone when you leave or reload the page. Only reads are run; anything that changes data is described and never sent.

ShopThe shop's name, currencies and languages.

The shop

GET/{shop}Key optional

The shop's name, logo, currencies and languages. Cacheable for 60 seconds.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

Responses

  • 200OKThe shop.
    • dataShop

      Fields of data
      • slugstring

        The shop's address, such as northwilds.

      • namestring

        The shop's name.

      • logoUrlstring or null

        The logo.

      • colourstring or null

        The brand colour, such as #1f2937.

      • currencystring

        The main currency, such as EUR.

      • currenciesstring[]

        Every currency the shop sells in, the main one first.

      • localesstring[]

        Every language, the main one first.

      • defaultLocalestring

        The main language, such as en.

      • pricesIncludeTaxboolean

        Whether prices include VAT.

      • shopUrlstring

        The hosted shop.

      • termsUrlstring or null

        The shop's terms.

      • returnsDaysinteger

        Days a shopper has to ask for a return after an order is sent. 0 when returns are by arrangement.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 120 requests a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds'

Try it

Example answer

200 OKJSON
{  "data": {    "slug": "northwilds",    "name": "Northwilds",    "logoUrl": "https://media.northwilds.com/brand/logo.svg",    "colour": "#1f2937",    "currency": "NOK",    "currencies": [      "NOK",      "EUR"    ],    "locales": [      "nb",      "en"    ],    "defaultLocale": "nb",    "pricesIncludeTax": true,    "shopUrl": "https://app.bifrostorbit.com/commerce/shop/northwilds",    "termsUrl": "https://northwilds.com/terms/",    "returnsDays": 30  }}

CatalogueProducts and collections, readable from any website.

List products

GET/{shop}/productsKey optional

Active products, by title. With a key that reads drafts, draft products too. There are no pages: the answer holds up to limit products, so narrow it with tag, collection or query, or ask for ids or slugs. Cacheable for 30 seconds, unless a customer token or a draft key is sent.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • idsstringquery

    Up to 100 product ids, separated by commas. The answer keeps your order.

  • slugsstringquery

    Up to 100 product addresses, separated by commas.

  • tagstringquery

    Only products with this tag.

  • collectionstringquery

    Only products in this collection, by address or id, in the collection's order.

  • querystringquery

    Products whose title contains this.

  • limitintegerquery

    How many. 100 unless you say, at most 250.

    Default 100. At least 1. At most 250.
  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

  • currencystringquery

    A currency, such as NOK. Prices are the shop's own price in it, never a conversion.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Responses

  • 200OKThe products.
    • dataProduct[]

      Fields of data
      • idstring

      • slugstring

        The product's address, such as fjell-gtx-boot.

      • titlestring

      • summarystring

      • descriptionstring

        HTML.

      • vendorstring or null

      • productTypestring or null

      • tagsstring[]

      • optionsobject[]

        Fields of options
        • namestring

          Such as Size.

        • valuesstring[]

      • variantsVariant[]

        Fields of Variant

      • imagesobject[]

        Fields of images
        • urlstring

          Image address.

        • altstring

          Alternative text.

      • specsobject[]

        Fields of specs
        • labelstring

        • valuestring

      • priceobject

        Fields of price
        • mininteger or null

          The lowest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • maxinteger or null

          The highest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • currencystring

        • compareAtinteger or null

          The highest price before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • availableboolean

        Any variant can be bought.

      • statusstring

        active, or draft with a key that reads drafts.

      • seoobject

        Fields of seo
        • titlestring

          Filled from the title when empty.

        • descriptionstring

          Filled from the summary when empty.

      • urlstring

        The product on the hosted shop.

      • localestring

        The language the text is in.

      • updatedAtstring

      • stockSyncedAtstring or null

        When stock last came from MAM.

      • pricingobject

        With a customer token: where the prices came from.

        Fields of pricing
        • sourcestring

          One of shop, priceList, account, loading, unavailable.
        • accountstring or null

          The MAM account number.

        • checkedAtstring or null

          When MAM answered.

      • giftCardboolean

        A gift card. Its code is emailed once the order is paid.

      • metafieldsmap of any

        Custom fields by key, only those the shop shows to websites.

      • bundleobject or null

        A bundle's products. Its quantity is how many whole bundles they make.

        Fields of bundle
        • componentsobject[]

          Fields of components
          • productIdstring

          • variantIdstring

          • quantityinteger

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 120 requests a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/products'

Try it

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f41001",      "slug": "fjellvind-down-jacket",      "title": "Fjellvind down jacket",      "summary": "A warm, light down jacket for cold days on the fjell.",      "description": "<p>A warm, light down jacket for cold days on the fjell.</p>",      "vendor": "Northwilds",      "productType": "Jackets",      "tags": [        "hiking",        "winter"      ],      "options": [        {          "name": "Size",          "values": [            "S",            "M",            "L"          ]        }      ],      "variants": [        {          "id": "6650f1c2a9e4b1d2c3f41101",          "title": "M",          "options": [            "M"          ],          "sku": "NW-FJV-M",          "price": 349900,          "compareAtPrice": null,          "available": true,          "quantity": 12,          "listPrice": null,          "priceSource": "shop",          "branches": null,          "volume": [],          "quantityRule": null,          "requiresShipping": true,          "digital": false,          "plans": [],          "metafields": {}        }      ],      "images": [        {          "url": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",          "alt": "The Fjellvind down jacket in dark green"        }      ],      "specs": [        {          "label": "Weight",          "value": "620 g"        }      ],      "price": {        "min": 349900,        "max": 349900,        "currency": "NOK",        "compareAt": null      },      "available": true,      "status": "active",      "seo": {        "title": "Fjellvind down jacket",        "description": "A warm, light down jacket for cold days on the fjell."      },      "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/fjellvind-down-jacket",      "locale": "en",      "updatedAt": "2026-11-02T09:30:00.000Z",      "stockSyncedAt": null,      "pricing": {        "source": "shop",        "account": null,        "checkedAt": null      },      "giftCard": false,      "metafields": {},      "bundle": null    },    {      "id": "6650f1c2a9e4b1d2c3f41002",      "slug": "stig-trekking-poles",      "title": "Stig trekking poles",      "summary": "Folding carbon poles that pack small.",      "description": "<p>Folding carbon poles that pack small.</p>",      "vendor": "Northwilds",      "productType": "Poles",      "tags": [        "hiking",        "winter"      ],      "options": [],      "variants": [        {          "id": "6650f1c2a9e4b1d2c3f41201",          "title": "Default",          "options": [],          "sku": "NW-STIG",          "price": 89900,          "compareAtPrice": null,          "available": true,          "quantity": 30,          "listPrice": null,          "priceSource": "shop",          "branches": null,          "volume": [],          "quantityRule": null,          "requiresShipping": true,          "digital": false,          "plans": [],          "metafields": {}        }      ],      "images": [        {          "url": "https://media.northwilds.com/gear/stig-trekking-poles.webp",          "alt": "A pair of Stig trekking poles"        }      ],      "specs": [        {          "label": "Weight",          "value": "480 g a pair"        }      ],      "price": {        "min": 89900,        "max": 89900,        "currency": "NOK",        "compareAt": null      },      "available": true,      "status": "active",      "seo": {        "title": "Stig trekking poles",        "description": "Folding carbon poles that pack small."      },      "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/stig-trekking-poles",      "locale": "en",      "updatedAt": "2026-11-02T09:30:00.000Z",      "stockSyncedAt": null,      "pricing": {        "source": "shop",        "account": null,        "checkedAt": null      },      "giftCard": false,      "metafields": {},      "bundle": null    },    {      "id": "6650f1c2a9e4b1d2c3f41003",      "slug": "tind-40-pack",      "title": "Tind 40 litre pack",      "summary": "A 40 litre pack for long days and hut-to-hut trips.",      "description": "<p>A 40 litre pack for long days and hut-to-hut trips.</p>",      "vendor": "Northwilds",      "productType": "Packs",      "tags": [        "hiking",        "winter"      ],      "options": [],      "variants": [        {          "id": "6650f1c2a9e4b1d2c3f41301",          "title": "Default",          "options": [],          "sku": "NW-TIND40",          "price": 199900,          "compareAtPrice": null,          "available": true,          "quantity": 8,          "listPrice": null,          "priceSource": "shop",          "branches": null,          "volume": [],          "quantityRule": null,          "requiresShipping": true,          "digital": false,          "plans": [],          "metafields": {}        }      ],      "images": [        {          "url": "https://media.northwilds.com/gear/tind-40-pack.webp",          "alt": "The Tind 40 litre pack on a rock"        }      ],      "specs": [        {          "label": "Weight",          "value": "1.4 kg"        }      ],      "price": {        "min": 199900,        "max": 199900,        "currency": "NOK",        "compareAt": null      },      "available": true,      "status": "active",      "seo": {        "title": "Tind 40 litre pack",        "description": "A 40 litre pack for long days and hut-to-hut trips."      },      "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/tind-40-pack",      "locale": "en",      "updatedAt": "2026-11-02T09:30:00.000Z",      "stockSyncedAt": null,      "pricing": {        "source": "shop",        "account": null,        "checkedAt": null      },      "giftCard": false,      "metafields": {},      "bundle": null    }  ]}

Get a product

GET/{shop}/products/{product}Key optional

One product, by address or id. Cacheable for 30 seconds.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • productstringpath, required

    The product's address or id.

  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

  • currencystringquery

    A currency, such as NOK. Prices are the shop's own price in it, never a conversion.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Responses

  • 200OKThe product.
    • dataProduct

      A product with live prices and stock.

      Fields of data
      • idstring

      • slugstring

        The product's address, such as fjell-gtx-boot.

      • titlestring

      • summarystring

      • descriptionstring

        HTML.

      • vendorstring or null

      • productTypestring or null

      • tagsstring[]

      • optionsobject[]

        Fields of options
        • namestring

          Such as Size.

        • valuesstring[]

      • variantsVariant[]

        Fields of Variant

      • imagesobject[]

        Fields of images
        • urlstring

          Image address.

        • altstring

          Alternative text.

      • specsobject[]

        Fields of specs
        • labelstring

        • valuestring

      • priceobject

        Fields of price
        • mininteger or null

          The lowest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • maxinteger or null

          The highest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • currencystring

        • compareAtinteger or null

          The highest price before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • availableboolean

        Any variant can be bought.

      • statusstring

        active, or draft with a key that reads drafts.

      • seoobject

        Fields of seo
        • titlestring

          Filled from the title when empty.

        • descriptionstring

          Filled from the summary when empty.

      • urlstring

        The product on the hosted shop.

      • localestring

        The language the text is in.

      • updatedAtstring

      • stockSyncedAtstring or null

        When stock last came from MAM.

      • pricingobject

        With a customer token: where the prices came from.

        Fields of pricing
        • sourcestring

          One of shop, priceList, account, loading, unavailable.
        • accountstring or null

          The MAM account number.

        • checkedAtstring or null

          When MAM answered.

      • giftCardboolean

        A gift card. Its code is emailed once the order is paid.

      • metafieldsmap of any

        Custom fields by key, only those the shop shows to websites.

      • bundleobject or null

        A bundle's products. Its quantity is how many whole bundles they make.

        Fields of bundle
        • componentsobject[]

          Fields of components
          • productIdstring

          • variantIdstring

          • quantityinteger

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo active product with that address or id. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 120 requests a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/products/fjellvind-down-jacket'

Try it

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f41001",    "slug": "fjellvind-down-jacket",    "title": "Fjellvind down jacket",    "summary": "A warm, light down jacket for cold days on the fjell.",    "description": "<p>A warm, light down jacket for cold days on the fjell.</p>",    "vendor": "Northwilds",    "productType": "Jackets",    "tags": [      "hiking",      "winter"    ],    "options": [      {        "name": "Size",        "values": [          "S",          "M",          "L"        ]      }    ],    "variants": [      {        "id": "6650f1c2a9e4b1d2c3f41101",        "title": "M",        "options": [          "M"        ],        "sku": "NW-FJV-M",        "price": 349900,        "compareAtPrice": null,        "available": true,        "quantity": 12,        "listPrice": null,        "priceSource": "shop",        "branches": null,        "volume": [],        "quantityRule": null,        "requiresShipping": true,        "digital": false,        "plans": [],        "metafields": {}      }    ],    "images": [      {        "url": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "alt": "The Fjellvind down jacket in dark green"      }    ],    "specs": [      {        "label": "Weight",        "value": "620 g"      }    ],    "price": {      "min": 349900,      "max": 349900,      "currency": "NOK",      "compareAt": null    },    "available": true,    "status": "active",    "seo": {      "title": "Fjellvind down jacket",      "description": "A warm, light down jacket for cold days on the fjell."    },    "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/fjellvind-down-jacket",    "locale": "en",    "updatedAt": "2026-11-02T09:30:00.000Z",    "stockSyncedAt": null,    "pricing": {      "source": "shop",      "account": null,      "checkedAt": null    },    "giftCard": false,    "metafields": {},    "bundle": null  }}

List collections

GET/{shop}/collectionsKey optional

Every active collection, by title, without their products. There are no pages. Cacheable for 60 seconds.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • idsstringquery

    Up to 100 collection ids, separated by commas.

  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

Responses

  • 200OKThe collections.
    • dataCollection[]

      Fields of data
      • idstring

      • slugstring

        The collection's address, such as tents.

      • titlestring

      • descriptionstring

      • imageobject or null

        Fields of image
        • urlstring

          Image address.

        • altstring

          Alternative text.

      • productCountinteger

        Active products in it.

      • urlstring

        The collection on the hosted shop.

      • productsProduct[]sometimes

        Only when you read one collection: its products in the collection's order.

        Fields of Product

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 120 requests a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/collections'

Try it

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f42001",      "slug": "hiking-gear",      "title": "Hiking gear",      "description": "What we pack for a day on the fjell.",      "image": {        "url": "https://media.northwilds.com/gear/tind-40-pack.webp",        "alt": "The Tind 40 litre pack on a rock"      },      "productCount": 3,      "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/collections/hiking-gear"    }  ]}

Get a collection

GET/{shop}/collections/{collection}Key optional

One collection, by address or id, with its first products in the collection's order. productCount tells you how many there are in all. Cacheable for 30 seconds.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • collectionstringpath, required

    The collection's address or id.

  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

  • currencystringquery

    A currency, such as NOK. Prices are the shop's own price in it, never a conversion.

  • limitintegerquery

    How many products. 100 unless you say.

    Default 100. At least 1.
  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Responses

  • 200OKThe collection with products.
    • dataCollection

      Fields of data
      • idstring

      • slugstring

        The collection's address, such as tents.

      • titlestring

      • descriptionstring

      • imageobject or null

        Fields of image
        • urlstring

          Image address.

        • altstring

          Alternative text.

      • productCountinteger

        Active products in it.

      • urlstring

        The collection on the hosted shop.

      • productsProduct[]sometimes

        Only when you read one collection: its products in the collection's order.

        Fields of Product

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA key that reads drafts, sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo active collection with that address or id. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 120 requests a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/collections/hiking-gear'

Try it

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f42001",    "slug": "hiking-gear",    "title": "Hiking gear",    "description": "What we pack for a day on the fjell.",    "image": {      "url": "https://media.northwilds.com/gear/tind-40-pack.webp",      "alt": "The Tind 40 litre pack on a rock"    },    "productCount": 3,    "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/collections/hiking-gear",    "products": [      {        "id": "6650f1c2a9e4b1d2c3f41003",        "slug": "tind-40-pack",        "title": "Tind 40 litre pack",        "summary": "A 40 litre pack for long days and hut-to-hut trips.",        "description": "<p>A 40 litre pack for long days and hut-to-hut trips.</p>",        "vendor": "Northwilds",        "productType": "Packs",        "tags": [          "hiking",          "winter"        ],        "options": [],        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41301",            "title": "Default",            "options": [],            "sku": "NW-TIND40",            "price": 199900,            "compareAtPrice": null,            "available": true,            "quantity": 8,            "listPrice": null,            "priceSource": "shop",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ],        "images": [          {            "url": "https://media.northwilds.com/gear/tind-40-pack.webp",            "alt": "The Tind 40 litre pack on a rock"          }        ],        "specs": [          {            "label": "Weight",            "value": "1.4 kg"          }        ],        "price": {          "min": 199900,          "max": 199900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "status": "active",        "seo": {          "title": "Tind 40 litre pack",          "description": "A 40 litre pack for long days and hut-to-hut trips."        },        "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/tind-40-pack",        "locale": "en",        "updatedAt": "2026-11-02T09:30:00.000Z",        "stockSyncedAt": null,        "pricing": {          "source": "shop",          "account": null,          "checkedAt": null        },        "giftCard": false,        "metafields": {},        "bundle": null      },      {        "id": "6650f1c2a9e4b1d2c3f41002",        "slug": "stig-trekking-poles",        "title": "Stig trekking poles",        "summary": "Folding carbon poles that pack small.",        "description": "<p>Folding carbon poles that pack small.</p>",        "vendor": "Northwilds",        "productType": "Poles",        "tags": [          "hiking",          "winter"        ],        "options": [],        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41201",            "title": "Default",            "options": [],            "sku": "NW-STIG",            "price": 89900,            "compareAtPrice": null,            "available": true,            "quantity": 30,            "listPrice": null,            "priceSource": "shop",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ],        "images": [          {            "url": "https://media.northwilds.com/gear/stig-trekking-poles.webp",            "alt": "A pair of Stig trekking poles"          }        ],        "specs": [          {            "label": "Weight",            "value": "480 g a pair"          }        ],        "price": {          "min": 89900,          "max": 89900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "status": "active",        "seo": {          "title": "Stig trekking poles",          "description": "Folding carbon poles that pack small."        },        "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/stig-trekking-poles",        "locale": "en",        "updatedAt": "2026-11-02T09:30:00.000Z",        "stockSyncedAt": null,        "pricing": {          "source": "shop",          "account": null,          "checkedAt": null        },        "giftCard": false,        "metafields": {},        "bundle": null      },      {        "id": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "title": "Fjellvind down jacket",        "summary": "A warm, light down jacket for cold days on the fjell.",        "description": "<p>A warm, light down jacket for cold days on the fjell.</p>",        "vendor": "Northwilds",        "productType": "Jackets",        "tags": [          "hiking",          "winter"        ],        "options": [          {            "name": "Size",            "values": [              "S",              "M",              "L"            ]          }        ],        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41101",            "title": "M",            "options": [              "M"            ],            "sku": "NW-FJV-M",            "price": 349900,            "compareAtPrice": null,            "available": true,            "quantity": 12,            "listPrice": null,            "priceSource": "shop",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ],        "images": [          {            "url": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",            "alt": "The Fjellvind down jacket in dark green"          }        ],        "specs": [          {            "label": "Weight",            "value": "620 g"          }        ],        "price": {          "min": 349900,          "max": 349900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "status": "active",        "seo": {          "title": "Fjellvind down jacket",          "description": "A warm, light down jacket for cold days on the fjell."        },        "url": "https://app.bifrostorbit.com/commerce/shop/northwilds/products/fjellvind-down-jacket",        "locale": "en",        "updatedAt": "2026-11-02T09:30:00.000Z",        "stockSyncedAt": null,        "pricing": {          "source": "shop",          "account": null,          "checkedAt": null        },        "giftCard": false,        "metafields": {},        "bundle": null      }    ]  }}

CartsCarts and checkout, from the shop's own websites.

Start a cart

POST/{shop}/cartsKey optional

Starts a cart and answers with it. The body takes any of the cart's fields, and source, up to 60 characters, to say where the order came from; it defaults to the calling website. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Request body, optional

  • currencystringoptional

    One of the shop's currencies.

    Up to 3 characters.
  • localestringoptional

    One of the shop's languages.

    Up to 10 characters.
  • linesobject[]optional

    Replaces every line. A quantity of 0 removes a line. Send each line's planId again to keep it a subscription.

    Up to 100 items.
    Fields of lines
    • variantIdstringrequired

      Up to 40 characters.
    • productIdstringoptional

    • quantityintegerrequired

      At least 0. At most 999.
    • planIdstring or any or nulloptional

  • addobject[]optional

    Lines to add. Adds to a line already there, up to 999. A planId given here, or null, changes that line's plan.

    Up to 50 items.
    Fields of add
    • variantIdstringrequired

      Up to 40 characters.
    • productIdstringoptional

    • quantityintegerrequired

      At least 0. At most 999.
    • planIdstring or any or nulloptional

  • emailstring or any or nulloptional

    The shopper. An email that belongs to a customer in a company gives the cart that company's prices and terms.

  • namestring or any or nulloptional

    The shopper's name.

  • phonestring or any or nulloptional

    The shopper's phone.

  • vatNumberstring or any or nulloptional

    A business buyer's VAT number, such as DE123456789. It can make the order reverse charged.

  • discountCodestring or any or nulloptional

    A discount code, such as WINTER15.

  • giftCardsstring[]optional

    Gift card codes. Replaces the ones there; [] removes them all. Spaces, hyphens and small letters don't matter.

    Up to 5 items.
  • shippingAddressobject or any or nulloptional

    Where it goes.

    Fields of shippingAddress

    One of:

    object

    • namestringrequired

      Up to 120 characters.
    • companystring or any or nulloptional

      Default null.
    • line1stringrequired

      Up to 160 characters.
    • line2string or any or nulloptional

      Default null.
    • postalCodestringrequired

      Up to 20 characters.
    • citystringrequired

      Up to 80 characters.
    • regionstring or any or nulloptional

      Default null.
    • countrystringrequired

      Up to 2 characters.
    • phonestring or any or nulloptional

      Default null.

    any or null

  • billingAddressobject or any or nulloptional

    Where the invoice goes, if not the delivery address.

    Fields of billingAddress

    One of:

    object

    • namestringrequired

      Up to 120 characters.
    • companystring or any or nulloptional

      Default null.
    • line1stringrequired

      Up to 160 characters.
    • line2string or any or nulloptional

      Default null.
    • postalCodestringrequired

      Up to 20 characters.
    • citystringrequired

      Up to 80 characters.
    • regionstring or any or nulloptional

      Default null.
    • countrystringrequired

      Up to 2 characters.
    • phonestring or any or nulloptional

      Default null.

    any or null

  • countrystringoptional

    Two letters, such as NO, for shipping choices and VAT before there is an address.

    Up to 2 characters.
  • shippingobject or object or any or nulloptional

    A choice from shippingChoices: kind rate with rateId (and a servicePoint for a rate that needs one), or kind pickup with locationId.

    Fields of shipping

    One of:

    object or object

    One of:

    object

    • kind"rate"required

    • rateIdstringrequired

    • servicePointobject or any or nulloptional

      Fields of servicePoint

      One of:

      object

      • idstringrequired

        Up to 40 characters.
      • namestringrequired

        Up to 160 characters.
      • addressstringrequired

        Up to 240 characters.
      • carrierstringrequired

        Up to 60 characters.

      any or null

    object

    • kind"pickup"required

    • locationIdstringrequired

    any or null

  • notestring or any or nulloptional

    A note from the shopper.

Responses

  • 201CreatedThe new cart.
    • dataCart

      A cart, priced.

      Fields of data
      • tokenstring

        The cart's token, such as c_Q2x…. Anyone with it can read and change the cart.

      • currencystring

      • currenciesstring[]

      • localestring

      • linesCartLine[]

        Fields of CartLine

      • countinteger

        Items in the cart.

      • emailstring or null

      • namestring or null

      • phonestring or null

      • vatNumberstring or null

      • companyobject or null

        The shopper's company, from their email.

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

        • onStopboolean

      • discountCodestring or null

      • discountProblemstring or null

        Why the code doesn't apply, such as That code has expired. It doesn't stop checkout.

      • shippingAddressAddress or any or null

        Fields of shippingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • billingAddressAddress or any or null

        Without one, the order is billed to the delivery address.

        Fields of billingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • vatobject or null

        The VAT number check.

        Fields of vat
        • numberstring

        • statusstring

          One of valid, invalid, unavailable.
        • namestring or null

          The business name VIES has.

      • salesTaxstring or null

        For a shop that charges US sales tax.

        One of added, needsAddress.
      • verifiedEmailstring or null

        The email confirmed with a code from the verify endpoint.

      • countrystring

        For shipping choices and VAT before there is an address.

      • shippingany or any or null

        The shipping chosen: kind rate with rateId, or kind pickup with locationId.

      • shippingChoicesShippingChoice[]

        Fields of ShippingChoice

      • totalsobject or null

        null while the cart can't be priced.

        Fields of totals
        • subtotalinteger

          Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountTotalinteger

          Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • shippingTotalinteger

          Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTotalinteger

          Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • totalinteger

          The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTax

          Fields of Tax

        • discountobject or null

          Fields of discount
          • codestring

          • amountinteger

            Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountsDiscount[]

          Fields of Discount

        • giftCardTotalinteger

          Paid by gift cards. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • amountDueinteger

          What is left to pay by card. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • offersDiscount[]

        Every discount used.

        Fields of Discount

      • giftCardsobject[]

        Fields of giftCards
        • codestring

        • last4string

        • amountinteger

          What it pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger

          What stays on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • giftCardProblemsstring[]

        Why a code can't be used. Stops checkout.

      • giftCardCodesstring[]

      • badGiftCardsstring[]

        The codes giftCardProblems names, to remove.

      • pricesstring

        list for the shop's or a price list's prices, account when every line has the MAM account's price, fallback when MAM didn't answer for some lines.

        One of list, account, fallback.
      • customerobject or null

        With a customer token.

        Fields of customer
        • namestring

        • emailstring

      • accountobject or null

        With a customer token and a MAM account.

        Fields of account
        • numberstring

        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • overCreditboolean

          This order would take the account over its limit.

        • branchstring or null

      • pricesCheckedAtstring or null

        When MAM answered.

      • problemsstring[]

        What stops checkout, such as Gas canister is sold in multiples of 6.

      • orderIdstring or null

        The order once checked out.

      • needsShippingboolean

        false when every line is a download or a gift card. The cart then needs no shipping choice or address.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 5 new carts a minute from one network, after a first 10.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts' \  -H 'Content-Type: application/json' \  -d '{"currency":"NOK","locale":"nb","add":[{"variantId":"6650f1c2a9e4b1d2c3f41101","quantity":1},{"variantId":"6650f1c2a9e4b1d2c3f41201","quantity":1}]}'

Try it

It starts a real cart in the shop. Try it in the API playground in Commerce Orbit, with the shop's own products.

Example answer

201 CreatedJSON
{  "data": {    "token": "c_Q2xNw7fjK4pLm9Rt",    "currency": "NOK",    "currencies": [      "NOK",      "EUR"    ],    "locale": "nb",    "lines": [      {        "variantId": "6650f1c2a9e4b1d2c3f41101",        "productId": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "title": "Fjellvind down jacket",        "variantTitle": "M",        "sku": "NW-FJV-M",        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "quantity": 1,        "unitPrice": 349900,        "listPrice": 349900,        "total": 349900,        "available": 12,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      },      {        "variantId": "6650f1c2a9e4b1d2c3f41201",        "productId": "6650f1c2a9e4b1d2c3f41002",        "slug": "stig-trekking-poles",        "title": "Stig trekking poles",        "variantTitle": null,        "sku": "NW-STIG",        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp",        "quantity": 1,        "unitPrice": 89900,        "listPrice": 89900,        "total": 89900,        "available": 30,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      }    ],    "count": 2,    "email": null,    "name": null,    "phone": null,    "vatNumber": null,    "company": null,    "discountCode": null,    "discountProblem": null,    "shippingAddress": null,    "billingAddress": null,    "vat": null,    "salesTax": null,    "verifiedEmail": null,    "country": "NO",    "shipping": null,    "shippingChoices": [      {        "kind": "rate",        "id": "posten-home",        "name": "Posten, delivered home",        "price": 9900,        "free": false,        "minDays": 2,        "maxDays": 4,        "servicePoint": false      },      {        "kind": "pickup",        "id": "oslo-shop",        "name": "Collect from the Oslo shop",        "price": 0,        "free": true,        "minDays": 0,        "maxDays": 1      }    ],    "totals": {      "subtotal": 438800,      "discountTotal": 0,      "shippingTotal": 0,      "taxTotal": 87760,      "total": 438800,      "tax": {        "mode": "domestic",        "country": "NO",        "pricesIncludeTax": true,        "lines": [          {            "rate": 25,            "base": 351040,            "tax": 87760          }        ]      },      "discount": null,      "discounts": [],      "giftCardTotal": 0,      "amountDue": 438800    },    "offers": [],    "giftCards": [],    "giftCardProblems": [],    "giftCardCodes": [],    "badGiftCards": [],    "prices": "list",    "customer": null,    "account": null,    "pricesCheckedAt": null,    "problems": [],    "orderId": null,    "needsShipping": true  }}

Read a cart

GET/{shop}/carts/{token}Key optional

The cart, priced. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • tokenstringpath, required

    The cart's token, from starting the cart.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Responses

  • 200OKThe cart.
    • dataCart

      A cart, priced.

      Fields of data
      • tokenstring

        The cart's token, such as c_Q2x…. Anyone with it can read and change the cart.

      • currencystring

      • currenciesstring[]

      • localestring

      • linesCartLine[]

        Fields of CartLine

      • countinteger

        Items in the cart.

      • emailstring or null

      • namestring or null

      • phonestring or null

      • vatNumberstring or null

      • companyobject or null

        The shopper's company, from their email.

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

        • onStopboolean

      • discountCodestring or null

      • discountProblemstring or null

        Why the code doesn't apply, such as That code has expired. It doesn't stop checkout.

      • shippingAddressAddress or any or null

        Fields of shippingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • billingAddressAddress or any or null

        Without one, the order is billed to the delivery address.

        Fields of billingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • vatobject or null

        The VAT number check.

        Fields of vat
        • numberstring

        • statusstring

          One of valid, invalid, unavailable.
        • namestring or null

          The business name VIES has.

      • salesTaxstring or null

        For a shop that charges US sales tax.

        One of added, needsAddress.
      • verifiedEmailstring or null

        The email confirmed with a code from the verify endpoint.

      • countrystring

        For shipping choices and VAT before there is an address.

      • shippingany or any or null

        The shipping chosen: kind rate with rateId, or kind pickup with locationId.

      • shippingChoicesShippingChoice[]

        Fields of ShippingChoice

      • totalsobject or null

        null while the cart can't be priced.

        Fields of totals
        • subtotalinteger

          Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountTotalinteger

          Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • shippingTotalinteger

          Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTotalinteger

          Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • totalinteger

          The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTax

          Fields of Tax

        • discountobject or null

          Fields of discount
          • codestring

          • amountinteger

            Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountsDiscount[]

          Fields of Discount

        • giftCardTotalinteger

          Paid by gift cards. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • amountDueinteger

          What is left to pay by card. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • offersDiscount[]

        Every discount used.

        Fields of Discount

      • giftCardsobject[]

        Fields of giftCards
        • codestring

        • last4string

        • amountinteger

          What it pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger

          What stays on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • giftCardProblemsstring[]

        Why a code can't be used. Stops checkout.

      • giftCardCodesstring[]

      • badGiftCardsstring[]

        The codes giftCardProblems names, to remove.

      • pricesstring

        list for the shop's or a price list's prices, account when every line has the MAM account's price, fallback when MAM didn't answer for some lines.

        One of list, account, fallback.
      • customerobject or null

        With a customer token.

        Fields of customer
        • namestring

        • emailstring

      • accountobject or null

        With a customer token and a MAM account.

        Fields of account
        • numberstring

        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • overCreditboolean

          This order would take the account over its limit.

        • branchstring or null

      • pricesCheckedAtstring or null

        When MAM answered.

      • problemsstring[]

        What stops checkout, such as Gas canister is sold in multiples of 6.

      • orderIdstring or null

        The order once checked out.

      • needsShippingboolean

        false when every line is a download or a gift card. The cart then needs no shipping choice or address.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo cart with that token. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts/c_Q2xNw7fjK4pLm9Rt'

Try it

Carts only answer the shop's own websites, so a browser on the docs gets 403. Use the API playground in Commerce Orbit.

Example answer

200 OKJSON
{  "data": {    "token": "c_Q2xNw7fjK4pLm9Rt",    "currency": "NOK",    "currencies": [      "NOK",      "EUR"    ],    "locale": "nb",    "lines": [      {        "variantId": "6650f1c2a9e4b1d2c3f41101",        "productId": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "title": "Fjellvind down jacket",        "variantTitle": "M",        "sku": "NW-FJV-M",        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "quantity": 1,        "unitPrice": 349900,        "listPrice": 349900,        "total": 349900,        "available": 12,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      },      {        "variantId": "6650f1c2a9e4b1d2c3f41201",        "productId": "6650f1c2a9e4b1d2c3f41002",        "slug": "stig-trekking-poles",        "title": "Stig trekking poles",        "variantTitle": null,        "sku": "NW-STIG",        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp",        "quantity": 1,        "unitPrice": 89900,        "listPrice": 89900,        "total": 89900,        "available": 30,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      }    ],    "count": 2,    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "phone": "+47 912 34 567",    "vatNumber": null,    "company": null,    "discountCode": null,    "discountProblem": null,    "shippingAddress": {      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 12",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567"    },    "billingAddress": null,    "vat": null,    "salesTax": null,    "verifiedEmail": null,    "country": "NO",    "shipping": {      "kind": "rate",      "rateId": "posten-home"    },    "shippingChoices": [      {        "kind": "rate",        "id": "posten-home",        "name": "Posten, delivered home",        "price": 9900,        "free": false,        "minDays": 2,        "maxDays": 4,        "servicePoint": false      },      {        "kind": "pickup",        "id": "oslo-shop",        "name": "Collect from the Oslo shop",        "price": 0,        "free": true,        "minDays": 0,        "maxDays": 1      }    ],    "totals": {      "subtotal": 438800,      "discountTotal": 0,      "shippingTotal": 9900,      "taxTotal": 89740,      "total": 448700,      "tax": {        "mode": "domestic",        "country": "NO",        "pricesIncludeTax": true,        "lines": [          {            "rate": 25,            "base": 358960,            "tax": 89740          }        ]      },      "discount": null,      "discounts": [],      "giftCardTotal": 0,      "amountDue": 448700    },    "offers": [],    "giftCards": [],    "giftCardProblems": [],    "giftCardCodes": [],    "badGiftCards": [],    "prices": "list",    "customer": null,    "account": null,    "pricesCheckedAt": null,    "problems": [],    "orderId": null,    "needsShipping": true  }}

Change a cart

PATCH/{shop}/carts/{token}Key optional

Send only what changes; null clears a field. Lines whose product isn't active are dropped. Changing a cart while its checkout waits for payment starts the checkout over. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • tokenstringpath, required

    The cart's token, from starting the cart.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Request body

  • currencystringoptional

    One of the shop's currencies.

    Up to 3 characters.
  • localestringoptional

    One of the shop's languages.

    Up to 10 characters.
  • linesobject[]optional

    Replaces every line. A quantity of 0 removes a line. Send each line's planId again to keep it a subscription.

    Up to 100 items.
    Fields of lines
    • variantIdstringrequired

      Up to 40 characters.
    • productIdstringoptional

    • quantityintegerrequired

      At least 0. At most 999.
    • planIdstring or any or nulloptional

  • addobject[]optional

    Lines to add. Adds to a line already there, up to 999. A planId given here, or null, changes that line's plan.

    Up to 50 items.
    Fields of add
    • variantIdstringrequired

      Up to 40 characters.
    • productIdstringoptional

    • quantityintegerrequired

      At least 0. At most 999.
    • planIdstring or any or nulloptional

  • emailstring or any or nulloptional

    The shopper. An email that belongs to a customer in a company gives the cart that company's prices and terms.

  • namestring or any or nulloptional

    The shopper's name.

  • phonestring or any or nulloptional

    The shopper's phone.

  • vatNumberstring or any or nulloptional

    A business buyer's VAT number, such as DE123456789. It can make the order reverse charged.

  • discountCodestring or any or nulloptional

    A discount code, such as WINTER15.

  • giftCardsstring[]optional

    Gift card codes. Replaces the ones there; [] removes them all. Spaces, hyphens and small letters don't matter.

    Up to 5 items.
  • shippingAddressobject or any or nulloptional

    Where it goes.

    Fields of shippingAddress

    One of:

    object

    • namestringrequired

      Up to 120 characters.
    • companystring or any or nulloptional

      Default null.
    • line1stringrequired

      Up to 160 characters.
    • line2string or any or nulloptional

      Default null.
    • postalCodestringrequired

      Up to 20 characters.
    • citystringrequired

      Up to 80 characters.
    • regionstring or any or nulloptional

      Default null.
    • countrystringrequired

      Up to 2 characters.
    • phonestring or any or nulloptional

      Default null.

    any or null

  • billingAddressobject or any or nulloptional

    Where the invoice goes, if not the delivery address.

    Fields of billingAddress

    One of:

    object

    • namestringrequired

      Up to 120 characters.
    • companystring or any or nulloptional

      Default null.
    • line1stringrequired

      Up to 160 characters.
    • line2string or any or nulloptional

      Default null.
    • postalCodestringrequired

      Up to 20 characters.
    • citystringrequired

      Up to 80 characters.
    • regionstring or any or nulloptional

      Default null.
    • countrystringrequired

      Up to 2 characters.
    • phonestring or any or nulloptional

      Default null.

    any or null

  • countrystringoptional

    Two letters, such as NO, for shipping choices and VAT before there is an address.

    Up to 2 characters.
  • shippingobject or object or any or nulloptional

    A choice from shippingChoices: kind rate with rateId (and a servicePoint for a rate that needs one), or kind pickup with locationId.

    Fields of shipping

    One of:

    object or object

    One of:

    object

    • kind"rate"required

    • rateIdstringrequired

    • servicePointobject or any or nulloptional

      Fields of servicePoint

      One of:

      object

      • idstringrequired

        Up to 40 characters.
      • namestringrequired

        Up to 160 characters.
      • addressstringrequired

        Up to 240 characters.
      • carrierstringrequired

        Up to 60 characters.

      any or null

    object

    • kind"pickup"required

    • locationIdstringrequired

    any or null

  • notestring or any or nulloptional

    A note from the shopper.

Responses

  • 200OKThe cart.
    • dataCart

      A cart, priced.

      Fields of data
      • tokenstring

        The cart's token, such as c_Q2x…. Anyone with it can read and change the cart.

      • currencystring

      • currenciesstring[]

      • localestring

      • linesCartLine[]

        Fields of CartLine

      • countinteger

        Items in the cart.

      • emailstring or null

      • namestring or null

      • phonestring or null

      • vatNumberstring or null

      • companyobject or null

        The shopper's company, from their email.

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

        • onStopboolean

      • discountCodestring or null

      • discountProblemstring or null

        Why the code doesn't apply, such as That code has expired. It doesn't stop checkout.

      • shippingAddressAddress or any or null

        Fields of shippingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • billingAddressAddress or any or null

        Without one, the order is billed to the delivery address.

        Fields of billingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • vatobject or null

        The VAT number check.

        Fields of vat
        • numberstring

        • statusstring

          One of valid, invalid, unavailable.
        • namestring or null

          The business name VIES has.

      • salesTaxstring or null

        For a shop that charges US sales tax.

        One of added, needsAddress.
      • verifiedEmailstring or null

        The email confirmed with a code from the verify endpoint.

      • countrystring

        For shipping choices and VAT before there is an address.

      • shippingany or any or null

        The shipping chosen: kind rate with rateId, or kind pickup with locationId.

      • shippingChoicesShippingChoice[]

        Fields of ShippingChoice

      • totalsobject or null

        null while the cart can't be priced.

        Fields of totals
        • subtotalinteger

          Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountTotalinteger

          Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • shippingTotalinteger

          Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTotalinteger

          Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • totalinteger

          The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTax

          Fields of Tax

        • discountobject or null

          Fields of discount
          • codestring

          • amountinteger

            Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountsDiscount[]

          Fields of Discount

        • giftCardTotalinteger

          Paid by gift cards. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • amountDueinteger

          What is left to pay by card. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • offersDiscount[]

        Every discount used.

        Fields of Discount

      • giftCardsobject[]

        Fields of giftCards
        • codestring

        • last4string

        • amountinteger

          What it pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger

          What stays on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • giftCardProblemsstring[]

        Why a code can't be used. Stops checkout.

      • giftCardCodesstring[]

      • badGiftCardsstring[]

        The codes giftCardProblems names, to remove.

      • pricesstring

        list for the shop's or a price list's prices, account when every line has the MAM account's price, fallback when MAM didn't answer for some lines.

        One of list, account, fallback.
      • customerobject or null

        With a customer token.

        Fields of customer
        • namestring

        • emailstring

      • accountobject or null

        With a customer token and a MAM account.

        Fields of account
        • numberstring

        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • overCreditboolean

          This order would take the account over its limit.

        • branchstring or null

      • pricesCheckedAtstring or null

        When MAM answered.

      • problemsstring[]

        What stops checkout, such as Gas canister is sold in multiples of 6.

      • orderIdstring or null

        The order once checked out.

      • needsShippingboolean

        false when every line is a download or a gift card. The cart then needs no shipping choice or address.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo cart with that token. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 409ConflictThe cart has already been ordered and paid. Start a new one.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsOnly when the body has giftCards: more than 20 a minute from one network for this shop.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X PATCH 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts/c_Q2xNw7fjK4pLm9Rt' \  -H 'Content-Type: application/json' \  -d '{"email":"kari.nordmann@northwilds.com","name":"Kari Nordmann","shippingAddress":{"name":"Kari Nordmann","company":null,"line1":"Storgata 12","line2":null,"postalCode":"0155","city":"Oslo","region":null,"country":"NO","phone":"+47 912 34 567"},"shipping":{"kind":"rate","rateId":"posten-home"}}'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": {    "token": "c_Q2xNw7fjK4pLm9Rt",    "currency": "NOK",    "currencies": [      "NOK",      "EUR"    ],    "locale": "nb",    "lines": [      {        "variantId": "6650f1c2a9e4b1d2c3f41101",        "productId": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "title": "Fjellvind down jacket",        "variantTitle": "M",        "sku": "NW-FJV-M",        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "quantity": 1,        "unitPrice": 349900,        "listPrice": 349900,        "total": 349900,        "available": 12,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      },      {        "variantId": "6650f1c2a9e4b1d2c3f41201",        "productId": "6650f1c2a9e4b1d2c3f41002",        "slug": "stig-trekking-poles",        "title": "Stig trekking poles",        "variantTitle": null,        "sku": "NW-STIG",        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp",        "quantity": 1,        "unitPrice": 89900,        "listPrice": 89900,        "total": 89900,        "available": 30,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      }    ],    "count": 2,    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "phone": "+47 912 34 567",    "vatNumber": null,    "company": null,    "discountCode": null,    "discountProblem": null,    "shippingAddress": {      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 12",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567"    },    "billingAddress": null,    "vat": null,    "salesTax": null,    "verifiedEmail": null,    "country": "NO",    "shipping": {      "kind": "rate",      "rateId": "posten-home"    },    "shippingChoices": [      {        "kind": "rate",        "id": "posten-home",        "name": "Posten, delivered home",        "price": 9900,        "free": false,        "minDays": 2,        "maxDays": 4,        "servicePoint": false      },      {        "kind": "pickup",        "id": "oslo-shop",        "name": "Collect from the Oslo shop",        "price": 0,        "free": true,        "minDays": 0,        "maxDays": 1      }    ],    "totals": {      "subtotal": 438800,      "discountTotal": 0,      "shippingTotal": 9900,      "taxTotal": 89740,      "total": 448700,      "tax": {        "mode": "domestic",        "country": "NO",        "pricesIncludeTax": true,        "lines": [          {            "rate": 25,            "base": 358960,            "tax": 89740          }        ]      },      "discount": null,      "discounts": [],      "giftCardTotal": 0,      "amountDue": 448700    },    "offers": [],    "giftCards": [],    "giftCardProblems": [],    "giftCardCodes": [],    "badGiftCards": [],    "prices": "list",    "customer": null,    "account": null,    "pricesCheckedAt": null,    "problems": [],    "orderId": null,    "needsShipping": true  }}

Check out

POST/{shop}/carts/{token}/checkoutKey optional

Creates the order and takes the stock. The cart needs lines, an email, a name, a shipping choice and an address (unless it is collection or only downloads), and no problems. Calling it again before the order is paid cancels the earlier unpaid order and makes a new one. A cart with a subscription line is paid by card only. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • tokenstringpath, required

    The cart's token, from starting the cart.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Request body, optional

  • methodstringoptional

    card unless you say. Gift cards can't be used with invoice.

    One of card, invoice.

Responses

  • 200OKThe order, and the payment to take.
    • dataCheckout

      Fields of data
      • orderIdstring

      • referencestring

        Such as NW1042.

      • statusstring

        pay: show Stripe's Payment Element with payment. placed: on invoice, or paid in full by gift cards.

        One of pay, placed.
      • paymentobject or null

        Fields of payment
        • kindstring

          Only payment.
        • clientSecretstring

          For Stripe's Payment Element.

        • publishableKeystring

          The shop's own Stripe publishable key.

        • amountinteger

          What the card pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • currencystring

  • 400Bad requestSomething the cart still needs, such as an email address, or a method other than card or invoice.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo cart with that token. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 409ConflictA problem in the cart, a payment the shop can't take, or price_changed when a MAM account's price changed since the cart showed it: read the cart again.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this cart.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts/c_Q2xNw7fjK4pLm9Rt/checkout' \  -H 'Content-Type: application/json' \  -d '{"method":"card"}'

Try it

It places a real order, takes stock and emails the customer.

Example answer

200 OKJSON
{  "data": {    "orderId": "6650f1c2a9e4b1d2c3f45001",    "reference": "NW1042",    "status": "pay",    "payment": {      "kind": "payment",      "clientSecret": "pi_3Q…_secret_…",      "publishableKey": "pk_live_…",      "amount": 448700,      "currency": "NOK"    }  }}

Confirm the shopper's email

POST/{shop}/carts/{token}/verifyKey optional

Without code, emails a 6-digit code to email and answers { sent: true }. With code, checks it and answers with the cart, whose verifiedEmail is then set and which gets the company's prices and terms for that email. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • tokenstringpath, required

    The cart's token, from starting the cart.

Request body

  • emailstringrequired

  • codestringoptional

    The 6-digit code from the email.

Responses

  • 200OKSent, or the cart once the code is right.
    • dataobject or Cart

      Fields of data

      One of:

      object

      • senttrue

      Cart

      • tokenstring

        The cart's token, such as c_Q2x…. Anyone with it can read and change the cart.

      • currencystring

      • currenciesstring[]

      • localestring

      • linesCartLine[]

        Fields of CartLine

      • countinteger

        Items in the cart.

      • emailstring or null

      • namestring or null

      • phonestring or null

      • vatNumberstring or null

      • companyobject or null

        The shopper's company, from their email.

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

        • onStopboolean

      • discountCodestring or null

      • discountProblemstring or null

        Why the code doesn't apply, such as That code has expired. It doesn't stop checkout.

      • shippingAddressAddress or any or null

        Fields of shippingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • billingAddressAddress or any or null

        Without one, the order is billed to the delivery address.

        Fields of billingAddress

        One of:

        Address

        • namestring

        • companystring or null

        • line1string

        • line2string or null

        • postalCodestring

        • citystring

        • regionstring or null

        • countrystring

          Two letters, such as NO.

        • phonestring or null

        any or null

      • vatobject or null

        The VAT number check.

        Fields of vat
        • numberstring

        • statusstring

          One of valid, invalid, unavailable.
        • namestring or null

          The business name VIES has.

      • salesTaxstring or null

        For a shop that charges US sales tax.

        One of added, needsAddress.
      • verifiedEmailstring or null

        The email confirmed with a code from the verify endpoint.

      • countrystring

        For shipping choices and VAT before there is an address.

      • shippingany or any or null

        The shipping chosen: kind rate with rateId, or kind pickup with locationId.

      • shippingChoicesShippingChoice[]

        Fields of ShippingChoice

      • totalsobject or null

        null while the cart can't be priced.

        Fields of totals
        • subtotalinteger

          Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountTotalinteger

          Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • shippingTotalinteger

          Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTotalinteger

          Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • totalinteger

          The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • taxTax

          Fields of Tax

        • discountobject or null

          Fields of discount
          • codestring

          • amountinteger

            Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • discountsDiscount[]

          Fields of Discount

        • giftCardTotalinteger

          Paid by gift cards. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • amountDueinteger

          What is left to pay by card. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • offersDiscount[]

        Every discount used.

        Fields of Discount

      • giftCardsobject[]

        Fields of giftCards
        • codestring

        • last4string

        • amountinteger

          What it pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger

          What stays on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • giftCardProblemsstring[]

        Why a code can't be used. Stops checkout.

      • giftCardCodesstring[]

      • badGiftCardsstring[]

        The codes giftCardProblems names, to remove.

      • pricesstring

        list for the shop's or a price list's prices, account when every line has the MAM account's price, fallback when MAM didn't answer for some lines.

        One of list, account, fallback.
      • customerobject or null

        With a customer token.

        Fields of customer
        • namestring

        • emailstring

      • accountobject or null

        With a customer token and a MAM account.

        Fields of account
        • numberstring

        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • overCreditboolean

          This order would take the account over its limit.

        • branchstring or null

      • pricesCheckedAtstring or null

        When MAM answered.

      • problemsstring[]

        What stops checkout, such as Gas canister is sold in multiples of 6.

      • orderIdstring or null

        The order once checked out.

      • needsShippingboolean

        false when every line is a download or a gift card. The cart then needs no shipping choice or address.

  • 400Bad requestNo email, or a wrong or expired code.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo cart with that token. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsSending: more than 1 code a minute for this cart, after a first 5. Checking: more than 2 tries a minute, after a first 10.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts/c_Q2xNw7fjK4pLm9Rt/verify' \  -H 'Content-Type: application/json' \  -d '{"email":"kari.nordmann@northwilds.com","code":"482913"}'

Try it

It emails a real code.

Example answer

200 OKJSON
{  "data": {    "token": "c_Q2xNw7fjK4pLm9Rt",    "currency": "NOK",    "currencies": [      "NOK",      "EUR"    ],    "locale": "nb",    "lines": [      {        "variantId": "6650f1c2a9e4b1d2c3f41101",        "productId": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "title": "Fjellvind down jacket",        "variantTitle": "M",        "sku": "NW-FJV-M",        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "quantity": 1,        "unitPrice": 349900,        "listPrice": 349900,        "total": 349900,        "available": 12,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      },      {        "variantId": "6650f1c2a9e4b1d2c3f41201",        "productId": "6650f1c2a9e4b1d2c3f41002",        "slug": "stig-trekking-poles",        "title": "Stig trekking poles",        "variantTitle": null,        "sku": "NW-STIG",        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp",        "quantity": 1,        "unitPrice": 89900,        "listPrice": 89900,        "total": 89900,        "available": 30,        "problem": null,        "priceSource": "shop",        "branches": null,        "quantityRule": null,        "volumePercent": 0,        "giftCard": false,        "planId": null,        "planName": null,        "digital": false      }    ],    "count": 2,    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "phone": "+47 912 34 567",    "vatNumber": null,    "company": null,    "discountCode": null,    "discountProblem": null,    "shippingAddress": {      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 12",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567"    },    "billingAddress": null,    "vat": null,    "salesTax": null,    "verifiedEmail": "kari.nordmann@northwilds.com",    "country": "NO",    "shipping": {      "kind": "rate",      "rateId": "posten-home"    },    "shippingChoices": [      {        "kind": "rate",        "id": "posten-home",        "name": "Posten, delivered home",        "price": 9900,        "free": false,        "minDays": 2,        "maxDays": 4,        "servicePoint": false      },      {        "kind": "pickup",        "id": "oslo-shop",        "name": "Collect from the Oslo shop",        "price": 0,        "free": true,        "minDays": 0,        "maxDays": 1      }    ],    "totals": {      "subtotal": 438800,      "discountTotal": 0,      "shippingTotal": 9900,      "taxTotal": 89740,      "total": 448700,      "tax": {        "mode": "domestic",        "country": "NO",        "pricesIncludeTax": true,        "lines": [          {            "rate": 25,            "base": 358960,            "tax": 89740          }        ]      },      "discount": null,      "discounts": [],      "giftCardTotal": 0,      "amountDue": 448700    },    "offers": [],    "giftCards": [],    "giftCardProblems": [],    "giftCardCodes": [],    "badGiftCards": [],    "prices": "list",    "customer": null,    "account": null,    "pricesCheckedAt": null,    "problems": [],    "orderId": null,    "needsShipping": true  }}

Service points near the address

GET/{shop}/carts/{token}/service-pointsKey optional

For a shipping choice with servicePoint true: the carrier's service points near the cart's address, to pass as shipping.servicePoint. Empty for a rate without service points. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • tokenstringpath, required

    The cart's token, from starting the cart.

  • ratestringquery, required

    The shipping choice's id.

Responses

  • 200OKThe service points.
  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo cart with that token. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this cart.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/carts/c_Q2xNw7fjK4pLm9Rt/service-points?rate=posten-pickup-point'

Try it

It needs a real cart, from one of the shop's own websites.

Example answer

200 OKJSON
{  "data": {    "points": [      {        "id": "122045",        "name": "Coop Mega Storgata",        "address": "Storgata 25, 0184 Oslo",        "carrier": "Posten"      },      {        "id": "122187",        "name": "Narvesen Oslo S",        "address": "Jernbanetorget 1, 0154 Oslo",        "carrier": "Posten"      }    ]  }}

OrdersThe order and its receipt.

Get an order

GET/{shop}/orders/{reference}Key optional

The order for a thank-you or order page. If a card payment is still waiting, Commerce Orbit asks Stripe first, so the answer is current when the shopper comes back from paying. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • referencestringpath, required

    The order number.

  • emailstringquery, required

    The email the order was placed with. Any other gets 404.

Responses

  • 200OKThe order.
    • dataOrder

      An order for a thank-you or order page.

      Fields of data
      • referencestring

        Such as NW1042.

      • statusstring

        One of open, cancelled, closed.
      • paymentStatusstring

        One of pending, paid, failed, invoiced, partiallyRefunded, refunded.
      • fulfilmentstring

        One of unfulfilled, partial, fulfilled.
      • placedAtstring

      • currencystring

      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

        • totalinteger

          The line total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • imagestring or null

      • subtotalinteger

        Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • discountTotalinteger

        Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • shippingTotalinteger

        Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • taxTotalinteger

        Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • totalinteger

        The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • pricesIncludeTaxboolean

      • taxModestring

        domestic, oss, reverseCharge, export or salesTax.

      • shippingstring or null

        The rate's or location's name.

      • trackingobject[]

        One entry per parcel.

        Fields of tracking
        • carrierstring or null

        • numberstring or null

        • urlstring or null

      • emailstring

      • downloadsDownload[]

        One for each file bought.

        Fields of Download

  • 400Bad requestNo email.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo order with that number and email. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this order.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/orders/NW1042?email=kari.nordmann%40northwilds.com'

Try it

It needs a real order and the email it was placed with.

Example answer

200 OKJSON
{  "data": {    "reference": "NW1042",    "status": "open",    "paymentStatus": "paid",    "fulfilment": "fulfilled",    "placedAt": "2026-11-02T09:30:00.000Z",    "currency": "NOK",    "lines": [      {        "title": "Fjellvind down jacket",        "variantTitle": "M",        "quantity": 1,        "total": 349900,        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp"      },      {        "title": "Stig trekking poles",        "variantTitle": null,        "quantity": 1,        "total": 89900,        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp"      }    ],    "subtotal": 438800,    "discountTotal": 0,    "shippingTotal": 9900,    "taxTotal": 89740,    "total": 448700,    "pricesIncludeTax": true,    "taxMode": "domestic",    "shipping": "Posten, delivered home",    "tracking": [      {        "carrier": "Posten",        "number": "70712345678901234",        "url": "https://sporing.posten.no/sporing/70712345678901234"      }    ],    "email": "kari.nordmann@northwilds.com",    "downloads": []  }}

Download the receipt

GET/{shop}/orders/{reference}/pdfKey optional

The receipt, or the invoice for an order on invoice, once it is paid or placed. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • referencestringpath, required

    The order number.

  • emailstringquery, required

    The email the order was placed with. Any other gets 404.

Responses

  • 200OKThe PDF, as an attachment.

    application/pdf

  • 400Bad requestNo email.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo order with that number and email. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 409ConflictThe order isn't paid yet.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this order.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/orders/NW1042/pdf?email=kari.nordmann%40northwilds.com'

Try it

It needs a real order and the email it was placed with.

ReturnsAsk for and follow a return.

What can be returned

GET/{shop}/returnsKey optional

What can be returned from an order, and the returns already asked for. For a signed-in customer, leave out email and send the customer token. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • referencestringquery, required

    The order number.

  • emailstringquery

    The email the order was placed with. Leave out with a customer token.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Responses

  • 200OKWhat can come back.
    • dataReturnOptions

      Fields of data
      • orderReferencestring

      • openboolean

        Whether a return can be asked for now.

      • untilstring or null

        The end of the return window.

      • reasonstring or null

        Why not, when open is false.

      • closedstring or null

        One of cancelled, noReturns, notSent, expired, allReturned.
      • linesobject[]

        Fields of lines
        • lineIdstring

        • titlestring

        • variantTitlestring or null

        • imagestring or null

        • leftinteger

          How many can still come back.

      • returnsReturn[]

        Returns already asked for.

        Fields of Return

  • 400Bad requestNo order number or email.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo order with that number and email. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this order.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/returns?reference=NW1042'

Try it

It needs a real order and the email it was placed with.

Example answer

200 OKJSON
{  "data": {    "orderReference": "NW1042",    "open": true,    "until": "2026-12-05T09:30:00.000Z",    "reason": null,    "closed": null,    "lines": [      {        "lineId": "l1",        "title": "Fjellvind down jacket",        "variantTitle": "M",        "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp",        "left": 1      },      {        "lineId": "l2",        "title": "Stig trekking poles",        "variantTitle": null,        "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp",        "left": 1      }    ],    "returns": []  }}

Ask for a return

POST/{shop}/returnsKey optional

The shop's team gets a notification and the customer an email. With a customer token, email can be left out. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader

    A signed-in customer's token. Answers then carry that customer's prices and stock, and are never cached.

Request body

  • referencestringrequired

    Up to 40 characters.
  • emailstringrequired

  • linesobject[]required

    Up to 100 items.
    Fields of lines
    • lineIdstringrequired

      Up to 20 characters.
    • quantityintegerrequired

      At least 1. At most 999.
    • reasonstringrequired

      One of tooSmall, tooBig, notAsDescribed, damaged, wrongItem, changedMind, other.
  • notestring or any or nulloptional

Responses

  • 201CreatedThe return.
    • dataReturn

      Fields of data
      • referencestring

        Such as R1001.

      • orderReferencestring

      • statusstring

        One of requested, approved, rejected, received, refunded, cancelled.
      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

        • reasonstring

        • receivedinteger

      • notestring or null

      • decisionNotestring or null

        The shop's message, once approved or rejected.

      • labelobject or null

        Fields of label
        • carrierstring or null

        • trackingNumberstring or null

        • trackingUrlstring or null

        • labelUrlstring or null

      • refundAmountinteger or null

        What was refunded. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • createdAtstring

  • 400Bad requestA line that isn't on the order.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo order with that number and email. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 409ConflictThe return window has closed, or nothing on the order can come back.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 5 a minute from one network for this order, after a first 10.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/returns' \  -H 'Content-Type: application/json' \  -d '{"reference":"NW1042","email":"kari.nordmann@northwilds.com","lines":[{"lineId":"l1","quantity":1,"reason":"tooSmall"}],"note":"The jacket is a little tight across the shoulders."}'

Try it

It asks for a real return and emails the customer.

Example answer

201 CreatedJSON
{  "data": {    "reference": "R1001",    "orderReference": "NW1042",    "status": "requested",    "lines": [      {        "title": "Fjellvind down jacket",        "variantTitle": "M",        "quantity": 1,        "reason": "tooSmall",        "received": 0      }    ],    "note": "The jacket is a little tight across the shoulders.",    "decisionNote": null,    "label": null,    "refundAmount": null,    "currency": "NOK",    "createdAt": "2026-11-06T14:12:00.000Z"  }}

Get a return

GET/{shop}/returns/{reference}Key optional

A return, by its number. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • referencestringpath, required

    The return number.

  • emailstringquery, required

    The email the order was placed with. Any other gets 404.

Responses

  • 200OKThe return.
    • dataReturn

      Fields of data
      • referencestring

        Such as R1001.

      • orderReferencestring

      • statusstring

        One of requested, approved, rejected, received, refunded, cancelled.
      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

        • reasonstring

        • receivedinteger

      • notestring or null

      • decisionNotestring or null

        The shop's message, once approved or rejected.

      • labelobject or null

        Fields of label
        • carrierstring or null

        • trackingNumberstring or null

        • trackingUrlstring or null

        • labelUrlstring or null

      • refundAmountinteger or null

        What was refunded. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • createdAtstring

  • 400Bad requestNo email.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo return with that number and email. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this return.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/returns/R1001?email=kari.nordmann%40northwilds.com'

Try it

It needs a real return and its email.

Example answer

200 OKJSON
{  "data": {    "reference": "R1001",    "orderReference": "NW1042",    "status": "approved",    "lines": [      {        "title": "Fjellvind down jacket",        "variantTitle": "M",        "quantity": 1,        "reason": "tooSmall",        "received": 0      }    ],    "note": "The jacket is a little tight across the shoulders.",    "decisionNote": "Thanks, Kari. Drop it off at any post office with the label.",    "label": {      "carrier": "Posten",      "trackingNumber": "70798765432109876",      "trackingUrl": "https://sporing.posten.no/sporing/70798765432109876",      "labelUrl": "https://media.northwilds.com/returns/R1001-label.pdf"    },    "refundAmount": null,    "currency": "NOK",    "createdAt": "2026-11-06T14:12:00.000Z"  }}

Gift cardsA gift card's balance.

Check a gift card's balance

POST/{shop}/gift-cardsKey optional

Allows 2 tries a minute from one network, after a first 10. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

Request body

  • codestringrequired

    The code. Spaces, hyphens and small letters don't matter.

Responses

  • 200OKThe balance.
    • dataGiftCardBalance

      Fields of data
      • last4string

      • balanceinteger

        What is left on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • expiresAtstring or null

      • usableboolean

  • 400Bad requestNo code.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo gift card with that code. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 2 tries a minute from one network, after a first 10.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/gift-cards' \  -H 'Content-Type: application/json' \  -d '{"code":"7KQ2-MNB4-XW8P-3HTR"}'

Try it

It needs a real gift card code.

Example answer

200 OKJSON
{  "data": {    "last4": "3HTR",    "balance": 50000,    "currency": "NOK",    "expiresAt": "2027-12-31T23:00:00.000Z",    "usable": true  }}

Customer accountsSign-in with an email code, the customer's account and personal prices.

Send a sign-in code

POST/{shop}/customer/codeKey optional

Emails a 6-digit code that works for 10 minutes. It always answers { sent: true }, so it never tells anyone whether an address has an account. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

Request body

  • emailstringrequired

  • localestringoptional

    The language of the email.

Responses

  • 200OKSent.
    • dataobject

      Fields of data
      • senttrue

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableNot an email address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 1 code a minute from one network, or for one email, after a first 5.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/code' \  -H 'Content-Type: application/json' \  -d '{"email":"kari.nordmann@northwilds.com","locale":"nb"}'

Try it

It emails a real code.

Example answer

200 OKJSON
{  "data": {    "sent": true  }}

Sign a customer in

POST/{shop}/customer/sessionKey optional

Swaps the email and code for a customer token that lasts 30 days, and makes the account the first time. name is only used for a new account. cart moves that cart over to the customer. Five wrong codes end the code. Keep the token like a password and send it back in X-Customer-Token. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

Request body

  • emailstringrequired

  • codestringrequired

  • namestringoptional

    For a new account.

  • cartstringoptional

    A cart token to move to the customer.

Responses

  • 200OKSigned in.
    • dataobject

      Fields of data
      • tokenstring

        The customer token, such as cst_….

      • expiresAtstring

      • createdboolean

        A new account.

      • customerCustomer

        Fields of Customer

  • 201CreatedSigned in to a new account.
    • dataobject

      Fields of data
  • 400Bad requestA wrong or expired code.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableNot an email address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 2 tries a minute from one network, after a first 10.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/session' \  -H 'Content-Type: application/json' \  -d '{"email":"kari.nordmann@northwilds.com","code":"482913","name":"Kari Nordmann","cart":"c_Q2xNw7fjK4pLm9Rt"}'

Try it

It needs a code from a real inbox.

Example answer

200 OKJSON
{  "data": {    "token": "cst_…",    "expiresAt": "2026-12-02T09:30:00.000Z",    "created": false,    "customer": {      "email": "kari.nordmann@northwilds.com",      "name": "Kari Nordmann",      "company": null,      "account": null,      "pendingRequest": null,      "priceList": null,      "phone": "+47 912 34 567",      "marketing": true,      "addresses": [        {          "id": "a1",          "name": "Kari Nordmann",          "company": null,          "line1": "Storgata 12",          "line2": null,          "postalCode": "0155",          "city": "Oslo",          "region": null,          "country": "NO",          "phone": "+47 912 34 567",          "defaultShipping": true,          "defaultBilling": true        }      ],      "deletionRequestedAt": null    }  }}

Sign out

DELETE/{shop}/customer/sessionKey optional

Ends the customer token. cart takes the customer's prices off that cart too. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

  • cartstringquery

    A cart token.

Responses

  • 200OKSigned out.
    • dataobject

      Fields of data
      • signedOuttrue

  • 401UnauthorisedA key that is wrong, revoked or expired, or a customer token that isn't valid or has expired.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X DELETE 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/session' \  -H 'X-Customer-Token: cst_…'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": {    "signedOut": true  }}

The signed-in customer

GET/{shop}/customerKey optional

The customer for a token. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe customer.
    • dataCustomer

      Fields of data
      • emailstring

        The sign-in. It can't be changed.

      • namestring

      • companyobject or null

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

      • accountobject or null

        The linked MAM account.

        Fields of account
        • numberstring

        • statusstring

          One of linked, unknown, stopped.
        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • branchstring or null

        • branchNamestring or null

      • pendingRequestobject or null

        Fields of pendingRequest
        • accountNumberstring

        • requestedAtstring

      • priceListstring or null

        The company's price list.

      • phonestring or null

      • marketingboolean

        Agreed to marketing email.

      • addressesSavedAddress[]

        Fields of SavedAddress

      • deletionRequestedAtstring or null

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": {    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "company": null,    "account": null,    "pendingRequest": null,    "priceList": null,    "phone": "+47 912 34 567",    "marketing": true,    "addresses": [      {        "id": "a1",        "name": "Kari Nordmann",        "company": null,        "line1": "Storgata 12",        "line2": null,        "postalCode": "0155",        "city": "Oslo",        "region": null,        "country": "NO",        "phone": "+47 912 34 567",        "defaultShipping": true,        "defaultBilling": true      }    ],    "deletionRequestedAt": null  }}

Change the customer's details

PATCH/{shop}/customerKey optional

Send only what changes. The email can't be changed, as it is the sign-in. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Request body

  • namestringoptional

    Up to 120 characters.
  • phonestring or nulloptional

    Up to 40 characters.
  • marketingbooleanoptional

    Agrees to marketing email.

Responses

  • 200OKThe customer.
    • dataCustomer

      Fields of data
      • emailstring

        The sign-in. It can't be changed.

      • namestring

      • companyobject or null

        Fields of company
        • namestring

        • termsstring

          One of card, invoice.
        • termsDaysinteger

      • accountobject or null

        The linked MAM account.

        Fields of account
        • numberstring

        • statusstring

          One of linked, unknown, stopped.
        • onStopboolean

        • creditLimitinteger or null

          The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • balanceinteger or null

          The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • branchstring or null

        • branchNamestring or null

      • pendingRequestobject or null

        Fields of pendingRequest
        • accountNumberstring

        • requestedAtstring

      • priceListstring or null

        The company's price list.

      • phonestring or null

      • marketingboolean

        Agreed to marketing email.

      • addressesSavedAddress[]

        Fields of SavedAddress

      • deletionRequestedAtstring or null

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this customer.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X PATCH 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer' \  -H 'X-Customer-Token: cst_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Kari Nordmann","phone":"+47 912 34 567","marketing":true}'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": {    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "company": null,    "account": null,    "pendingRequest": null,    "priceList": null,    "phone": "+47 912 34 567",    "marketing": true,    "addresses": [      {        "id": "a1",        "name": "Kari Nordmann",        "company": null,        "line1": "Storgata 12",        "line2": null,        "postalCode": "0155",        "city": "Oslo",        "region": null,        "country": "NO",        "phone": "+47 912 34 567",        "defaultShipping": true,        "defaultBilling": true      }    ],    "deletionRequestedAt": null  }}

The customer's orders

GET/{shop}/customer/ordersKey optional

Newest first. There are no pages: ask for up to 100 with limit. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

  • limitintegerquery

    20 unless you say, up to 100.

    Default 20. At least 1. At most 100.

Responses

  • 200OKThe orders.
    • dataAccountOrder[]

      Fields of data
      • referencestring

        Such as NW1042.

      • statusstring

        One of open, cancelled, closed.
      • paymentStatusstring

        One of pending, paid, failed, invoiced, partiallyRefunded, refunded.
      • fulfilmentstring

        One of unfulfilled, partial, fulfilled.
      • placedAtstring

      • currencystring

      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

        • totalinteger

          The line total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • imagestring or null

      • subtotalinteger

        Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • discountTotalinteger

        Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • shippingTotalinteger

        Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • taxTotalinteger

        Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • totalinteger

        The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • pricesIncludeTaxboolean

      • taxModestring

        domestic, oss, reverseCharge, export or salesTax.

      • shippingstring or null

        The rate's or location's name.

      • trackingobject[]

        One entry per parcel.

        Fields of tracking
        • carrierstring or null

        • numberstring or null

        • urlstring or null

      • emailstring

      • reorderobject[]

        What to add to a cart for Order again.

        Fields of reorder
        • productIdstring

        • variantIdstring

        • quantityinteger

      • receiptboolean

        Whether a receipt or invoice can be downloaded.

      • invoiceNumberstring or null

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/orders' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": [    {      "reference": "NW1042",      "status": "open",      "paymentStatus": "paid",      "fulfilment": "fulfilled",      "placedAt": "2026-11-02T09:30:00.000Z",      "currency": "NOK",      "lines": [        {          "title": "Fjellvind down jacket",          "variantTitle": "M",          "quantity": 1,          "total": 349900,          "image": "https://media.northwilds.com/gear/fjellvind-down-jacket.webp"        },        {          "title": "Stig trekking poles",          "variantTitle": null,          "quantity": 1,          "total": 89900,          "image": "https://media.northwilds.com/gear/stig-trekking-poles.webp"        }      ],      "subtotal": 438800,      "discountTotal": 0,      "shippingTotal": 9900,      "taxTotal": 89740,      "total": 448700,      "pricesIncludeTax": true,      "taxMode": "domestic",      "shipping": "Posten, delivered home",      "tracking": [        {          "carrier": "Posten",          "number": "70712345678901234",          "url": "https://sporing.posten.no/sporing/70712345678901234"        }      ],      "email": "kari.nordmann@northwilds.com",      "reorder": [        {          "productId": "6650f1c2a9e4b1d2c3f41001",          "variantId": "6650f1c2a9e4b1d2c3f41101",          "quantity": 1        },        {          "productId": "6650f1c2a9e4b1d2c3f41002",          "variantId": "6650f1c2a9e4b1d2c3f41201",          "quantity": 1        }      ],      "receipt": true,      "invoiceNumber": null    }  ]}

The address book

GET/{shop}/customer/addressesKey optional

Up to 20 addresses. Addresses the customer orders with are added by themselves. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe address book.
    • dataSavedAddress[]

      Fields of data
      • idstring

      • namestring

      • companystring or null

      • line1string

      • line2string or null

      • postalCodestring

      • citystring

      • regionstring or null

      • countrystring

      • phonestring or null

      • defaultShippingboolean

      • defaultBillingboolean

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/addresses' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": [    {      "id": "a1",      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 12",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567",      "defaultShipping": true,      "defaultBilling": true    }  ]}

Add an address

POST/{shop}/customer/addressesKey optional

Answers with the whole book. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Request body

  • namestringrequired

    Up to 120 characters.
  • companystring or any or nulloptional

    Default null.
  • line1stringrequired

    Up to 160 characters.
  • line2string or any or nulloptional

    Default null.
  • postalCodestringrequired

    Up to 20 characters.
  • citystringrequired

    Up to 80 characters.
  • regionstring or any or nulloptional

    Default null.
  • countrystringrequired

    Up to 2 characters.
  • phonestring or any or nulloptional

    Default null.
  • defaultShippingbooleanoptional

  • defaultBillingbooleanoptional

Responses

  • 201CreatedThe address book.
    • dataSavedAddress[]

      Fields of data
      • idstring

      • namestring

      • companystring or null

      • line1string

      • line2string or null

      • postalCodestring

      • citystring

      • regionstring or null

      • countrystring

      • phonestring or null

      • defaultShippingboolean

      • defaultBillingboolean

  • 400Bad requestThe book already has 20 addresses.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this customer.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/addresses' \  -H 'X-Customer-Token: cst_…' \  -H 'Content-Type: application/json' \  -d '{"name":"Kari Nordmann","company":"Northwilds","line1":"Karl Johans gate 22","line2":null,"postalCode":"0159","city":"Oslo","region":null,"country":"NO","phone":null,"defaultBilling":true}'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

201 CreatedJSON
{  "data": [    {      "id": "a1",      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 12",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567",      "defaultShipping": true,      "defaultBilling": false    },    {      "id": "a2",      "name": "Kari Nordmann",      "company": "Northwilds",      "line1": "Karl Johans gate 22",      "line2": null,      "postalCode": "0159",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": null,      "defaultShipping": false,      "defaultBilling": true    }  ]}

Change an address

PATCH/{shop}/customer/addresses/{addressId}Key optional

Send only what changes, including defaultShipping and defaultBilling. Answers with the whole book. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • addressIdstringpath, required

    The address's id.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Request body

  • namestringoptional

    Up to 120 characters.
  • companystring or any or nulloptional

    Default null.
  • line1stringoptional

    Up to 160 characters.
  • line2string or any or nulloptional

    Default null.
  • postalCodestringoptional

    Up to 20 characters.
  • citystringoptional

    Up to 80 characters.
  • regionstring or any or nulloptional

    Default null.
  • countrystringoptional

    Up to 2 characters.
  • phonestring or any or nulloptional

    Default null.
  • defaultShippingbooleanoptional

  • defaultBillingbooleanoptional

Responses

  • 200OKThe address book.
    • dataSavedAddress[]

      Fields of data
      • idstring

      • namestring

      • companystring or null

      • line1string

      • line2string or null

      • postalCodestring

      • citystring

      • regionstring or null

      • countrystring

      • phonestring or null

      • defaultShippingboolean

      • defaultBillingboolean

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo such address. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 422UnprocessableA field that isn't valid, with issues.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this customer.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X PATCH 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/addresses/a1' \  -H 'X-Customer-Token: cst_…' \  -H 'Content-Type: application/json' \  -d '{"line1":"Storgata 14","phone":"+47 912 34 567"}'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": [    {      "id": "a1",      "name": "Kari Nordmann",      "company": null,      "line1": "Storgata 14",      "line2": null,      "postalCode": "0155",      "city": "Oslo",      "region": null,      "country": "NO",      "phone": "+47 912 34 567",      "defaultShipping": true,      "defaultBilling": true    }  ]}

Remove an address

DELETE/{shop}/customer/addresses/{addressId}Key optional

Answers with the whole book. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • addressIdstringpath, required

    The address's id.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe address book.
    • dataSavedAddress[]

      Fields of data
      • idstring

      • namestring

      • companystring or null

      • line1string

      • line2string or null

      • postalCodestring

      • citystring

      • regionstring or null

      • countrystring

      • phonestring or null

      • defaultShippingboolean

      • defaultBillingboolean

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo such address. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 20 a minute from one network for this customer.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X DELETE 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/addresses/a1' \  -H 'X-Customer-Token: cst_…'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": []}

The customer's subscriptions

GET/{shop}/customer/subscriptionsKey optional

Newest first, up to 500. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe subscriptions.
    • dataSubscription[]

      Fields of data
      • idstring

      • emailstring

      • namestring

      • statusstring

        One of incomplete, active, pastDue, cancelling, cancelled.
      • everystring

        Such as Every month.

      • amountinteger

        Each period. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

      • nextAtstring or null

        The next payment, or the end for one that is cancelling.

      • ordersinteger

        Orders so far.

      • createdAtstring

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/subscriptions' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": [    {      "id": "6650f1c2a9e4b1d2c3f44001",      "email": "kari.nordmann@northwilds.com",      "name": "Kari Nordmann",      "status": "active",      "every": "Every month",      "amount": 14900,      "currency": "NOK",      "lines": [        {          "title": "Trail coffee, 500 g",          "variantTitle": null,          "quantity": 1        }      ],      "nextAt": "2026-12-02T09:30:00.000Z",      "orders": 3,      "createdAt": "2026-08-02T09:30:00.000Z"    }  ]}

Cancel a subscription

DELETE/{shop}/customer/subscriptions/{subscriptionId}Key optional

Cancels at the end of the period paid for, and answers with it. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • subscriptionIdstringpath, required

    The subscription's id.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe subscription, now cancelling.
    • dataSubscription

      Fields of data
      • idstring

      • emailstring

      • namestring

      • statusstring

        One of incomplete, active, pastDue, cancelling, cancelled.
      • everystring

        Such as Every month.

      • amountinteger

        Each period. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • linesobject[]

        Fields of lines
        • titlestring

        • variantTitlestring or null

        • quantityinteger

      • nextAtstring or null

        The next payment, or the end for one that is cancelling.

      • ordersinteger

        Orders so far.

      • createdAtstring

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNot the customer's subscription. Or no shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X DELETE 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/subscriptions/6650f1c2a9e4b1d2c3f44001' \  -H 'X-Customer-Token: cst_…'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": {    "id": "6650f1c2a9e4b1d2c3f44001",    "email": "kari.nordmann@northwilds.com",    "name": "Kari Nordmann",    "status": "cancelling",    "every": "Every month",    "amount": 14900,    "currency": "NOK",    "lines": [      {        "title": "Trail coffee, 500 g",        "variantTitle": null,        "quantity": 1      }    ],    "nextAt": "2026-12-02T09:30:00.000Z",    "orders": 3,    "createdAt": "2026-08-02T09:30:00.000Z"  }}

The customer's downloads

GET/{shop}/customer/downloadsKey optional

Files the customer bought, newest order first. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKThe downloads.
    • dataobject[]

      Fields of data
      • referencestring

        The order number.

      • grantIdstring

      • lineIdstring

      • titlestring

      • filenamestring

      • sizeinteger

        Bytes.

      • urlstring

        Works for 7 days. Read again for a fresh one.

      • downloadsinteger

        Used.

      • limitinteger or null

      • expiresAtstring or null

      • usableboolean

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/downloads' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": [    {      "reference": "NW1042",      "grantId": "6650f1c2a9e4b1d2c3f43001",      "lineId": "l3",      "title": "Lofoten hiking map",      "filename": "lofoten-hiking-map.pdf",      "size": 4812733,      "url": "https://app.bifrostorbit.com/commerce/api/public/northwilds/downloads/6650f1c2a9e4b1d2c3f43001?until=20768&signature=…",      "downloads": 1,      "limit": 5,      "expiresAt": null,      "usable": true    }  ]}

Ask to delete the account

POST/{shop}/customer/deletionKey optional

The team gets a notification and closes the account; the orders stay for their accounts. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

Responses

  • 200OKAsked.
    • dataobject

      Fields of data
      • requestedtrue

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 1 a minute from one network for this customer, after a first 5.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/customer/deletion' \  -H 'X-Customer-Token: cst_…'

Try it

It changes data, so it is described here and not run from the docs.

Example answer

200 OKJSON
{  "data": {    "requested": true  }}

Personal prices

GET/{shop}/pricesKey optional

The signed-in customer's prices for products you already show, to lay over a cached page. 30 calls a minute for each customer and network. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

  • idsstringquery

    Up to 100 product ids, separated by commas.

  • slugsstringquery

    Up to 100 product addresses, separated by commas.

  • currencystringquery

    A currency, such as NOK. Prices are the shop's own price in it, never a conversion.

  • branchesstringquery

    yours, or all to add every branch.

    One of yours, all.
  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

Responses

  • 200OKThe prices.
    • dataPersonalPrices

      Fields of data
      • accountstring or null

        The MAM account number.

      • priceListstring or null

      • onStopboolean

      • checkedAtstring or null

        When MAM answered.

      • productsobject[]

        Fields of products
        • idstring

        • slugstring

        • currencystring

        • sourcestring

          One of shop, priceList, account, loading, unavailable.
        • priceobject

          Fields of price
          • mininteger or null

            Lowest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

          • maxinteger or null

            Highest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

          • currencystring

          • compareAtinteger or null

            Before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • availableboolean

        • variantsVariant[]

          Fields of Variant

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 30 a minute for this customer from one network.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl 'https://app.bifrostorbit.com/commerce/api/public/northwilds/prices' \  -H 'X-Customer-Token: cst_…'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": {    "account": null,    "priceList": "Turlaget members",    "onStop": false,    "checkedAt": null,    "products": [      {        "id": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "currency": "NOK",        "source": "priceList",        "price": {          "min": 314900,          "max": 314900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41101",            "title": "M",            "options": [              "M"            ],            "sku": "NW-FJV-M",            "price": 314900,            "compareAtPrice": null,            "available": true,            "quantity": 12,            "listPrice": 349900,            "priceSource": "priceList",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ]      },      {        "id": "6650f1c2a9e4b1d2c3f41003",        "slug": "tind-40-pack",        "currency": "NOK",        "source": "priceList",        "price": {          "min": 179900,          "max": 179900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41301",            "title": "Default",            "options": [],            "sku": "NW-TIND40",            "price": 179900,            "compareAtPrice": null,            "available": true,            "quantity": 8,            "listPrice": 199900,            "priceSource": "priceList",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ]      }    ]  }}

Personal prices, in a body

POST/{shop}/pricesKey optional

The same as the GET, for long lists. Only the shop's Website and Allowed websites in Settings, the hosted shop, and servers can call it.

Parameters

  • shopstringpath, required

    The shop address from Settings, such as northwilds.

  • X-Customer-Tokenstringheader, required

    The signed-in customer's token, from the session endpoint.

  • localestringquery

    A language, such as nb. Without it, or with one the shop doesn't offer, the main language.

Request body

  • productIdsstring[]optional

    Up to 100 items.
  • slugsstring[]optional

    Up to 100 items.
  • currencystringoptional

  • branchesstringoptional

    One of yours, all.

Responses

  • 200OKThe prices.
    • dataPersonalPrices

      Fields of data
      • accountstring or null

        The MAM account number.

      • priceListstring or null

      • onStopboolean

      • checkedAtstring or null

        When MAM answered.

      • productsobject[]

        Fields of products
        • idstring

        • slugstring

        • currencystring

        • sourcestring

          One of shop, priceList, account, loading, unavailable.
        • priceobject

          Fields of price
          • mininteger or null

            Lowest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

          • maxinteger or null

            Highest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

          • currencystring

          • compareAtinteger or null

            Before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

        • availableboolean

        • variantsVariant[]

          Fields of Variant

  • 401UnauthorisedNo customer token, or one that isn't valid or has expired, or a wrong key.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 402Payment requiredThe shop is paused because its plan has ended.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 403ForbiddenA website that isn't in the shop's allowed websites, or a key that reads drafts sent from a browser.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 404Not foundNo shop with that address.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 429Too many requestsMore than 30 a minute for this customer from one network.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

  • 500Server errorSomething went wrong on our side.
    • errorobject

      Fields of error
      • codestring

        A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

      • messagestring

        A message you can show to shoppers as it is.

      • issuesany[]sometimes

        On 422 only: one entry per field that failed.

Shell
curl -X POST 'https://app.bifrostorbit.com/commerce/api/public/northwilds/prices' \  -H 'X-Customer-Token: cst_…' \  -H 'Content-Type: application/json' \  -d '{"productIds":["6650f1c2a9e4b1d2c3f41001","6650f1c2a9e4b1d2c3f41003"],"currency":"NOK","branches":"yours"}'

Try it

It needs a signed-in customer.

Example answer

200 OKJSON
{  "data": {    "account": null,    "priceList": "Turlaget members",    "onStop": false,    "checkedAt": null,    "products": [      {        "id": "6650f1c2a9e4b1d2c3f41001",        "slug": "fjellvind-down-jacket",        "currency": "NOK",        "source": "priceList",        "price": {          "min": 314900,          "max": 314900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41101",            "title": "M",            "options": [              "M"            ],            "sku": "NW-FJV-M",            "price": 314900,            "compareAtPrice": null,            "available": true,            "quantity": 12,            "listPrice": 349900,            "priceSource": "priceList",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ]      },      {        "id": "6650f1c2a9e4b1d2c3f41003",        "slug": "tind-40-pack",        "currency": "NOK",        "source": "priceList",        "price": {          "min": 179900,          "max": 179900,          "currency": "NOK",          "compareAt": null        },        "available": true,        "variants": [          {            "id": "6650f1c2a9e4b1d2c3f41301",            "title": "Default",            "options": [],            "sku": "NW-TIND40",            "price": 179900,            "compareAtPrice": null,            "available": true,            "quantity": 8,            "listPrice": 199900,            "priceSource": "priceList",            "branches": null,            "volume": [],            "quantityRule": null,            "requiresShipping": true,            "digital": false,            "plans": [],            "metafields": {}          }        ]      }    ]  }}

SchemasThe shapes the endpoints above answer with and take.

Error

  • errorobject

    Fields of error
    • codestring

      A stable code, such as not_found, invalid, forbidden, rate_limited or price_changed.

    • messagestring

      A message you can show to shoppers as it is.

    • issuesany[]sometimes

      On 422 only: one entry per field that failed.

Shop

  • slugstring

    The shop's address, such as northwilds.

  • namestring

    The shop's name.

  • logoUrlstring or null

    The logo.

  • colourstring or null

    The brand colour, such as #1f2937.

  • currencystring

    The main currency, such as EUR.

  • currenciesstring[]

    Every currency the shop sells in, the main one first.

  • localesstring[]

    Every language, the main one first.

  • defaultLocalestring

    The main language, such as en.

  • pricesIncludeTaxboolean

    Whether prices include VAT.

  • shopUrlstring

    The hosted shop.

  • termsUrlstring or null

    The shop's terms.

  • returnsDaysinteger

    Days a shopper has to ask for a return after an order is sent. 0 when returns are by arrangement.

Branch

  • codestring

    The MAM branch code.

  • namestring

    The branch name.

  • quantityinteger or null

    Units in stock there.

  • yoursboolean

    The customer's own branch.

Plan

  • idstring

    Pass as planId in a cart line to subscribe.

  • namestring

    Such as Monthly.

  • intervalstring

    One of week, month, year.
  • intervalCountinteger

    How many intervals between payments.

  • priceinteger or null

    The price each period, or null without a price in this currency. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

QuantityRule

  • mininteger

    The fewest in one order.

  • maxinteger or null

    The most in one order.

  • stepinteger

    The pack size. Step the quantity picker by it.

Variant

One variant of a product.

  • idstring

    The variant's id, for carts.

  • titlestring

    Such as 42 / Brown.

  • optionsstring[]

    The option values, in the product's option order.

  • skustring

  • priceinteger or null

    What the shopper pays each, or null when it has no price in this currency and can't be bought in it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • compareAtPriceinteger or null

    The price before a sale, only in the main currency. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • availableboolean

    Whether it can be bought.

  • quantityinteger or null

    Units in stock, or null when stock isn't tracked.

  • listPriceinteger or null

    The shop's normal price, to show struck through for a signed-in customer. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • priceSourcestring

    Where price came from. Not shop only with a customer token.

    One of shop, priceList, account, loading, unavailable.
  • branchesBranch[] or null

    With a customer token and a MAM account: live stock per branch.

    Fields of Branch

  • volumeobject[]

    Volume prices. Empty for a price from a MAM account.

    Fields of volume
    • mininteger

      From this many items of the product, across its variants.

    • percentnumber

      Percent off.

    • priceinteger

      Each costs this. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • quantityRuleQuantityRule or any or null

    Fields of quantityRule

    One of:

    QuantityRule

    • mininteger

      The fewest in one order.

    • maxinteger or null

      The most in one order.

    • stepinteger

      The pack size. Step the quantity picker by it.

    any or null

  • requiresShippingboolean

    Whether it is posted.

  • digitalboolean

    A download, nothing posted.

  • plansPlan[]

    Subscription plans.

    Fields of Plan

  • metafieldsmap of any

    Custom fields by key, only those the shop shows to websites.

Product

A product with live prices and stock.

  • idstring

  • slugstring

    The product's address, such as fjell-gtx-boot.

  • titlestring

  • summarystring

  • descriptionstring

    HTML.

  • vendorstring or null

  • productTypestring or null

  • tagsstring[]

  • optionsobject[]

    Fields of options
    • namestring

      Such as Size.

    • valuesstring[]

  • variantsVariant[]

    Fields of Variant

  • imagesobject[]

    Fields of images
    • urlstring

      Image address.

    • altstring

      Alternative text.

  • specsobject[]

    Fields of specs
    • labelstring

    • valuestring

  • priceobject

    Fields of price
    • mininteger or null

      The lowest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • maxinteger or null

      The highest variant price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • currencystring

    • compareAtinteger or null

      The highest price before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • availableboolean

    Any variant can be bought.

  • statusstring

    active, or draft with a key that reads drafts.

  • seoobject

    Fields of seo
    • titlestring

      Filled from the title when empty.

    • descriptionstring

      Filled from the summary when empty.

  • urlstring

    The product on the hosted shop.

  • localestring

    The language the text is in.

  • updatedAtstring

  • stockSyncedAtstring or null

    When stock last came from MAM.

  • pricingobject

    With a customer token: where the prices came from.

    Fields of pricing
    • sourcestring

      One of shop, priceList, account, loading, unavailable.
    • accountstring or null

      The MAM account number.

    • checkedAtstring or null

      When MAM answered.

  • giftCardboolean

    A gift card. Its code is emailed once the order is paid.

  • metafieldsmap of any

    Custom fields by key, only those the shop shows to websites.

  • bundleobject or null

    A bundle's products. Its quantity is how many whole bundles they make.

    Fields of bundle
    • componentsobject[]

      Fields of components
      • productIdstring

      • variantIdstring

      • quantityinteger

Collection

  • idstring

  • slugstring

    The collection's address, such as tents.

  • titlestring

  • descriptionstring

  • imageobject or null

    Fields of image
    • urlstring

      Image address.

    • altstring

      Alternative text.

  • productCountinteger

    Active products in it.

  • urlstring

    The collection on the hosted shop.

  • productsProduct[]sometimes

    Only when you read one collection: its products in the collection's order.

    Fields of Product

Address

  • namestring

  • companystring or null

  • line1string

  • line2string or null

  • postalCodestring

  • citystring

  • regionstring or null

  • countrystring

    Two letters, such as NO.

  • phonestring or null

CartLine

  • variantIdstring

  • productIdstring

  • slugstring

  • titlestring

  • variantTitlestring or null

  • skustring

  • imagestring or null

  • quantityinteger

  • unitPriceinteger

    What the shopper pays each. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • listPriceinteger

    Before a company price or volume price. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • totalinteger

    The line total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • availableinteger or null

    Units left, or null when stock isn't tracked.

  • problemstring or null

    Why this line can't be bought as it is, such as Only 2 of Tind 2 tent are left.

  • priceSourcestring

    One of shop, priceList, account, loading, unavailable.
  • branchesBranch[] or null

    Fields of Branch

  • quantityRuleQuantityRule or any or null

    Fields of quantityRule

    One of:

    QuantityRule

    • mininteger

      The fewest in one order.

    • maxinteger or null

      The most in one order.

    • stepinteger

      The pack size. Step the quantity picker by it.

    any or null

  • volumePercentnumber

    The volume tier reached, or 0.

  • giftCardboolean

  • planIdstring or null

    The subscription plan, or null.

  • planNamestring or null

  • digitalboolean

ShippingChoice

  • kindstring

    One of rate, pickup.
  • idstring

    Pass as rateId or locationId in shipping.

  • namestring

  • priceinteger or null

    The price, or null before it can be worked out. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • freeboolean

  • minDaysinteger or null

  • maxDaysinteger or null

  • servicePointbooleansometimes

    The shopper picks a service point for it. See the service points endpoint.

Discount

  • idstring

  • codestring or null

    null for an automatic offer.

  • titlestring

    Show an automatic offer by its title.

  • kindstring

    One of percent, fixed, freeShipping, buyXGetY.
  • automaticboolean

  • amountinteger

    What it takes off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • freeShippingboolean

Tax

  • modestring

    One of domestic, oss, reverseCharge, export, salesTax.
  • countrystring

  • pricesIncludeTaxboolean

  • linesobject[]

    VAT by rate.

    Fields of lines
    • ratenumber

      Such as 25.

    • baseinteger

      The amount taxed. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • taxinteger

      The tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • namestringsometimes

      A sales tax's name.

Cart

A cart, priced.

  • tokenstring

    The cart's token, such as c_Q2x…. Anyone with it can read and change the cart.

  • currencystring

  • currenciesstring[]

  • localestring

  • linesCartLine[]

    Fields of CartLine

  • countinteger

    Items in the cart.

  • emailstring or null

  • namestring or null

  • phonestring or null

  • vatNumberstring or null

  • companyobject or null

    The shopper's company, from their email.

    Fields of company
    • namestring

    • termsstring

      One of card, invoice.
    • termsDaysinteger

    • onStopboolean

  • discountCodestring or null

  • discountProblemstring or null

    Why the code doesn't apply, such as That code has expired. It doesn't stop checkout.

  • shippingAddressAddress or any or null

    Fields of shippingAddress

    One of:

    Address

    • namestring

    • companystring or null

    • line1string

    • line2string or null

    • postalCodestring

    • citystring

    • regionstring or null

    • countrystring

      Two letters, such as NO.

    • phonestring or null

    any or null

  • billingAddressAddress or any or null

    Without one, the order is billed to the delivery address.

    Fields of billingAddress

    One of:

    Address

    • namestring

    • companystring or null

    • line1string

    • line2string or null

    • postalCodestring

    • citystring

    • regionstring or null

    • countrystring

      Two letters, such as NO.

    • phonestring or null

    any or null

  • vatobject or null

    The VAT number check.

    Fields of vat
    • numberstring

    • statusstring

      One of valid, invalid, unavailable.
    • namestring or null

      The business name VIES has.

  • salesTaxstring or null

    For a shop that charges US sales tax.

    One of added, needsAddress.
  • verifiedEmailstring or null

    The email confirmed with a code from the verify endpoint.

  • countrystring

    For shipping choices and VAT before there is an address.

  • shippingany or any or null

    The shipping chosen: kind rate with rateId, or kind pickup with locationId.

  • shippingChoicesShippingChoice[]

    Fields of ShippingChoice

  • totalsobject or null

    null while the cart can't be priced.

    Fields of totals
    • subtotalinteger

      Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • discountTotalinteger

      Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • shippingTotalinteger

      Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • taxTotalinteger

      Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • totalinteger

      The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • taxTax

      Fields of Tax

    • discountobject or null

      Fields of discount
      • codestring

      • amountinteger

        Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • discountsDiscount[]

      Fields of Discount

    • giftCardTotalinteger

      Paid by gift cards. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • amountDueinteger

      What is left to pay by card. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • offersDiscount[]

    Every discount used.

    Fields of Discount

  • giftCardsobject[]

    Fields of giftCards
    • codestring

    • last4string

    • amountinteger

      What it pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • balanceinteger

      What stays on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • giftCardProblemsstring[]

    Why a code can't be used. Stops checkout.

  • giftCardCodesstring[]

  • badGiftCardsstring[]

    The codes giftCardProblems names, to remove.

  • pricesstring

    list for the shop's or a price list's prices, account when every line has the MAM account's price, fallback when MAM didn't answer for some lines.

    One of list, account, fallback.
  • customerobject or null

    With a customer token.

    Fields of customer
    • namestring

    • emailstring

  • accountobject or null

    With a customer token and a MAM account.

    Fields of account
    • numberstring

    • onStopboolean

    • creditLimitinteger or null

      The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • balanceinteger or null

      The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • overCreditboolean

      This order would take the account over its limit.

    • branchstring or null

  • pricesCheckedAtstring or null

    When MAM answered.

  • problemsstring[]

    What stops checkout, such as Gas canister is sold in multiples of 6.

  • orderIdstring or null

    The order once checked out.

  • needsShippingboolean

    false when every line is a download or a gift card. The cart then needs no shipping choice or address.

CartUpdate

  • currencystringsometimes

    One of the shop's currencies.

    Up to 3 characters.
  • localestringsometimes

    One of the shop's languages.

    Up to 10 characters.
  • linesobject[]sometimes

    Replaces every line. A quantity of 0 removes a line. Send each line's planId again to keep it a subscription.

    Up to 100 items.
    Fields of lines
    • variantIdstring

      Up to 40 characters.
    • productIdstringsometimes

    • quantityinteger

      At least 0. At most 999.
    • planIdstring or any or nullsometimes

  • addobject[]sometimes

    Lines to add. Adds to a line already there, up to 999. A planId given here, or null, changes that line's plan.

    Up to 50 items.
    Fields of add
    • variantIdstring

      Up to 40 characters.
    • productIdstringsometimes

    • quantityinteger

      At least 0. At most 999.
    • planIdstring or any or nullsometimes

  • emailstring or any or nullsometimes

    The shopper. An email that belongs to a customer in a company gives the cart that company's prices and terms.

  • namestring or any or nullsometimes

    The shopper's name.

  • phonestring or any or nullsometimes

    The shopper's phone.

  • vatNumberstring or any or nullsometimes

    A business buyer's VAT number, such as DE123456789. It can make the order reverse charged.

  • discountCodestring or any or nullsometimes

    A discount code, such as WINTER15.

  • giftCardsstring[]sometimes

    Gift card codes. Replaces the ones there; [] removes them all. Spaces, hyphens and small letters don't matter.

    Up to 5 items.
  • shippingAddressobject or any or nullsometimes

    Where it goes.

    Fields of shippingAddress

    One of:

    object

    • namestring

      Up to 120 characters.
    • companystring or any or nullsometimes

      Default null.
    • line1string

      Up to 160 characters.
    • line2string or any or nullsometimes

      Default null.
    • postalCodestring

      Up to 20 characters.
    • citystring

      Up to 80 characters.
    • regionstring or any or nullsometimes

      Default null.
    • countrystring

      Up to 2 characters.
    • phonestring or any or nullsometimes

      Default null.

    any or null

  • billingAddressobject or any or nullsometimes

    Where the invoice goes, if not the delivery address.

    Fields of billingAddress

    One of:

    object

    • namestring

      Up to 120 characters.
    • companystring or any or nullsometimes

      Default null.
    • line1string

      Up to 160 characters.
    • line2string or any or nullsometimes

      Default null.
    • postalCodestring

      Up to 20 characters.
    • citystring

      Up to 80 characters.
    • regionstring or any or nullsometimes

      Default null.
    • countrystring

      Up to 2 characters.
    • phonestring or any or nullsometimes

      Default null.

    any or null

  • countrystringsometimes

    Two letters, such as NO, for shipping choices and VAT before there is an address.

    Up to 2 characters.
  • shippingobject or object or any or nullsometimes

    A choice from shippingChoices: kind rate with rateId (and a servicePoint for a rate that needs one), or kind pickup with locationId.

    Fields of shipping

    One of:

    object or object

    One of:

    object

    • kind"rate"

    • rateIdstring

    • servicePointobject or any or nullsometimes

    object

    • kind"pickup"

    • locationIdstring

    any or null

  • notestring or any or nullsometimes

    A note from the shopper.

Checkout

  • orderIdstring

  • referencestring

    Such as NW1042.

  • statusstring

    pay: show Stripe's Payment Element with payment. placed: on invoice, or paid in full by gift cards.

    One of pay, placed.
  • paymentobject or null

    Fields of payment
    • kindstring

      Only payment.
    • clientSecretstring

      For Stripe's Payment Element.

    • publishableKeystring

      The shop's own Stripe publishable key.

    • amountinteger

      What the card pays. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • currencystring

Download

  • grantIdstring

  • lineIdstring

  • titlestring

  • filenamestring

  • sizeinteger

    Bytes.

  • urlstring

    Works for 7 days. Read again for a fresh one.

  • downloadsinteger

    Used.

  • limitinteger or null

  • expiresAtstring or null

  • usableboolean

Order

An order for a thank-you or order page.

  • referencestring

    Such as NW1042.

  • statusstring

    One of open, cancelled, closed.
  • paymentStatusstring

    One of pending, paid, failed, invoiced, partiallyRefunded, refunded.
  • fulfilmentstring

    One of unfulfilled, partial, fulfilled.
  • placedAtstring

  • currencystring

  • linesobject[]

    Fields of lines
    • titlestring

    • variantTitlestring or null

    • quantityinteger

    • totalinteger

      The line total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • imagestring or null

  • subtotalinteger

    Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • discountTotalinteger

    Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • shippingTotalinteger

    Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • taxTotalinteger

    Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • totalinteger

    The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • pricesIncludeTaxboolean

  • taxModestring

    domestic, oss, reverseCharge, export or salesTax.

  • shippingstring or null

    The rate's or location's name.

  • trackingobject[]

    One entry per parcel.

    Fields of tracking
    • carrierstring or null

    • numberstring or null

    • urlstring or null

  • emailstring

  • downloadsDownload[]

    One for each file bought.

    Fields of Download

AccountOrder

  • referencestring

    Such as NW1042.

  • statusstring

    One of open, cancelled, closed.
  • paymentStatusstring

    One of pending, paid, failed, invoiced, partiallyRefunded, refunded.
  • fulfilmentstring

    One of unfulfilled, partial, fulfilled.
  • placedAtstring

  • currencystring

  • linesobject[]

    Fields of lines
    • titlestring

    • variantTitlestring or null

    • quantityinteger

    • totalinteger

      The line total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • imagestring or null

  • subtotalinteger

    Before discounts and shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • discountTotalinteger

    Taken off. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • shippingTotalinteger

    Shipping. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • taxTotalinteger

    Tax. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • totalinteger

    The order total. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • pricesIncludeTaxboolean

  • taxModestring

    domestic, oss, reverseCharge, export or salesTax.

  • shippingstring or null

    The rate's or location's name.

  • trackingobject[]

    One entry per parcel.

    Fields of tracking
    • carrierstring or null

    • numberstring or null

    • urlstring or null

  • emailstring

  • reorderobject[]

    What to add to a cart for Order again.

    Fields of reorder
    • productIdstring

    • variantIdstring

    • quantityinteger

  • receiptboolean

    Whether a receipt or invoice can be downloaded.

  • invoiceNumberstring or null

ReturnOptions

  • orderReferencestring

  • openboolean

    Whether a return can be asked for now.

  • untilstring or null

    The end of the return window.

  • reasonstring or null

    Why not, when open is false.

  • closedstring or null

    One of cancelled, noReturns, notSent, expired, allReturned.
  • linesobject[]

    Fields of lines
    • lineIdstring

    • titlestring

    • variantTitlestring or null

    • imagestring or null

    • leftinteger

      How many can still come back.

  • returnsReturn[]

    Returns already asked for.

    Fields of Return

Return

  • referencestring

    Such as R1001.

  • orderReferencestring

  • statusstring

    One of requested, approved, rejected, received, refunded, cancelled.
  • linesobject[]

    Fields of lines
    • titlestring

    • variantTitlestring or null

    • quantityinteger

    • reasonstring

    • receivedinteger

  • notestring or null

  • decisionNotestring or null

    The shop's message, once approved or rejected.

  • labelobject or null

    Fields of label
    • carrierstring or null

    • trackingNumberstring or null

    • trackingUrlstring or null

    • labelUrlstring or null

  • refundAmountinteger or null

    What was refunded. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • currencystring

  • createdAtstring

ReturnRequest

  • referencestring

    Up to 40 characters.
  • emailstring

  • linesobject[]

    Up to 100 items.
    Fields of lines
    • lineIdstring

      Up to 20 characters.
    • quantityinteger

      At least 1. At most 999.
    • reasonstring

      One of tooSmall, tooBig, notAsDescribed, damaged, wrongItem, changedMind, other.
  • notestring or any or nullsometimes

GiftCardBalance

  • last4string

  • balanceinteger

    What is left on it. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • currencystring

  • expiresAtstring or null

  • usableboolean

ServicePoint

  • idstring

    Pass in shipping.servicePoint.

  • namestring

  • addressstring

  • carrierstring

SavedAddress

  • idstring

  • namestring

  • companystring or null

  • line1string

  • line2string or null

  • postalCodestring

  • citystring

  • regionstring or null

  • countrystring

  • phonestring or null

  • defaultShippingboolean

  • defaultBillingboolean

AddressInput

  • namestring

    Up to 120 characters.
  • companystring or any or nullsometimes

    Default null.
  • line1string

    Up to 160 characters.
  • line2string or any or nullsometimes

    Default null.
  • postalCodestring

    Up to 20 characters.
  • citystring

    Up to 80 characters.
  • regionstring or any or nullsometimes

    Default null.
  • countrystring

    Up to 2 characters.
  • phonestring or any or nullsometimes

    Default null.
  • defaultShippingbooleansometimes

  • defaultBillingbooleansometimes

Customer

  • emailstring

    The sign-in. It can't be changed.

  • namestring

  • companyobject or null

    Fields of company
    • namestring

    • termsstring

      One of card, invoice.
    • termsDaysinteger

  • accountobject or null

    The linked MAM account.

    Fields of account
    • numberstring

    • statusstring

      One of linked, unknown, stopped.
    • onStopboolean

    • creditLimitinteger or null

      The credit limit. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • balanceinteger or null

      The balance. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • branchstring or null

    • branchNamestring or null

  • pendingRequestobject or null

    Fields of pendingRequest
    • accountNumberstring

    • requestedAtstring

  • priceListstring or null

    The company's price list.

  • phonestring or null

  • marketingboolean

    Agreed to marketing email.

  • addressesSavedAddress[]

    Fields of SavedAddress

  • deletionRequestedAtstring or null

Subscription

  • idstring

  • emailstring

  • namestring

  • statusstring

    One of incomplete, active, pastDue, cancelling, cancelled.
  • everystring

    Such as Every month.

  • amountinteger

    Each period. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

  • currencystring

  • linesobject[]

    Fields of lines
    • titlestring

    • variantTitlestring or null

    • quantityinteger

  • nextAtstring or null

    The next payment, or the end for one that is cancelling.

  • ordersinteger

    Orders so far.

  • createdAtstring

PersonalPrices

  • accountstring or null

    The MAM account number.

  • priceListstring or null

  • onStopboolean

  • checkedAtstring or null

    When MAM answered.

  • productsobject[]

    Fields of products
    • idstring

    • slugstring

    • currencystring

    • sourcestring

      One of shop, priceList, account, loading, unavailable.
    • priceobject

      Fields of price
      • mininteger or null

        Lowest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • maxinteger or null

        Highest. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

      • currencystring

      • compareAtinteger or null

        Before a sale. In minor units of the currency, so 349900 with NOK is NOK 3,499.00.

    • availableboolean

    • variantsVariant[]

      Fields of Variant