Marketplace
    • Getting an API token
    • Introduction
    • Customers
      • Get a list of Customer Fields
        GET
      • Retrieve Customer Fields matching the given ID
        GET
      • Get a list of Customers
        GET
      • Retrieve Customers matching the given ID
        GET
      • Update a Customer
        PUT
      • Delete a Customer
        DELETE
      • Bulk Add/Update Customers
        POST
      • Create a new Customer
        POST
      • Get a list of Orders
        GET
    • Distributors
      • Get a list of Distributors
        GET
      • Retrieve Distributors matching the given ID
        GET
      • Update a Distributor
        PUT
      • Delete a Distributor
        DELETE
      • Create a new Distributor
        POST
    • Warehouses
      • Get a list of Warehouses
        GET
      • Retrieve Warehouses matching the given ID
        GET
      • Update a Warehouse
        PUT
      • Delete a Warehouse
        DELETE
      • Bulk Add/Update Warehouses
        POST
      • Create a new Warehouse
        POST
    • Exports
      • Get available exports
        GET
      • Get parameter options
        GET
      • Run custom export
        POST
    • Orders
      • Get a list of Order Batches
      • Retrieve Order Batch matching the given order batch Ids (from orderBatches/list)
      • Update Order Batch status
      • Delete Order Batch
      • Create a new Order
      • Update an existing Order
      • Bulk Add/Update Orders
      • Bulk Update Order Batch Statuses
    • People
      • Get a list of People
      • Retrieve a specific Person by ID
      • Update a Person
      • Delete a Person
      • Create a new Person
      • Bulk Add/Update Persons
      • Get a list of roles
      • Get a list of person types
      • Retrieve a specific Person Type by ID
    • Products
      • Get a list of Products
      • Create a new Product
      • Bulk Add/Update Products
      • Retrieve Products matching the given ID
      • Update a Product
      • Delete a Product
      • Get a list of Product Skus
      • Create a new Product Sku
      • Update a Product Sku
      • Bulk Add/Update Product Skus
      • Get a list of Pricing information for a given product
      • Bulk Add/Update Pricing
      • Get a list of categories
      • Get a list of brands
      • Get a list of PriceZones
      • Get a list of Product Fields
      • Get a list of Product Sku Fields
      • Get a list of product options
      • Retrieve a product option matching the given ID
      • Update a product option
      • Delete a product option
      • Create a new product option
      • Update Pricing for a product that starts on a given date
      • Create new Pricing for a product
      • Delete Pricing for a product that starts on a given date
      • Retrieve a field matching the given ID
      • Add or update the component SKUs linked to a kit Product
      • Bulk Add/Update the component SKUs linked to kit Products, across any number of kits
    • Vendors
      • Get a list of Vendors
      • Retrieve Vendors matching the given ID
      • Update a Vendor
      • Delete a Vendor
      • Bulk Add/Update Vendors
      • Create a new Vendor
    • Content
    • Promotions
      • Get a list of Promotions
      • Retrieve the Promotion matching the given ID
      • Get a list of Deals linked to the given Promotion
      • Retrieve the Deal matching the given ID under the given Promotion
      • Update the Deal's details, and optionally its status. Card and banner appearance stays inherited from the Promotion
      • Bulk Add/Update fixed price Deals under the given Promotion
      • Set the Deal's fixed price reward, with a price per product
      • Add products to the Deal's fixed price reward pool
      • Set the Deal's warehouses, price zones, customers and delivery dates in one call
    • Imports
    • Product Skus
      • Retrieve Fields matching the given ID
      • Retrieve Product Skus matching the given ID
      • Delete a Product Sku
      • Bulk Add/Update Product Skus across multiple Products
    • Pricing
      • Retrieve Pricing for a product that starts on a given date
      • Bulk Add/Update Pricing across multiple products
    • PriceZones
      • Retrieve PriceZone by ID
    • Product Highlights
      • Get a list of product highlights
      • Add products to the product highlight with a name, creating it if there is none
      • Add products to a product highlight
    • Product Options
    • Schemas
      • Schemas
        • Export
        • ExportParameter
        • PriceAssociatedProductSku
        • PriceList
        • Pricing
      • BulkFailMessage
      • AddressApiInput
      • DealAvailability
      • BulkSkippedProduct
      • SelectionItem
      • ProductOption
      • Customer
      • Address
      • Country
      • State
      • Distributor
      • FreeStock
      • OrderBatch
      • OrderLine
      • Person
      • PersonType
      • PricingMutation
      • ProductSku
      • Vendor
      • Warehouse
      • WarehouseUnderDistributor
      • BulkUpdateResult
      • Deal
      • DealBulkItemApiInput
      • DealUpdateApiInput
      • FIELD_TYPE
      • PERMISSION
      • PriceListMutation
      • ProductSkuApiInput
      • SELECTION_TYPE
      • DealAvailabilityApiInput
      • BulkSuccessItem
      • DealBulkApiInput
      • CompleteOrder
      • DealDateRange
      • CompleteOrderApiInput
      • DealDeliveryDateRangeApiInput
      • CompleteOrderBulkApiInput
      • DealPagedResults
      • CompleteOrderQuantityApiInput
      • DealProductPrice
      • CompleteOrderWithIdApiInput
      • DealProductPriceApiInput
      • DealProductsApiInput
      • DealReward
      • CustomerApiInput
      • CustomerAssociation
      • ENTITY_STATUS
      • CustomerAssociationApiInput
      • EntityAssociationResult
      • CustomerBulkApiInput
      • FIELD_COMPONENT
      • CustomerOrdering
      • CustomerOrderingApiInput
      • CustomerRule
      • Field
      • CustomerRuleApiInput
      • FieldComponent
      • CustomersConnection
      • KitComponent
      • PagedResults
      • DistributorPagedResults
      • PriceZone
      • ENTITY_STATUS_WITH_TEST
      • PricingCrossProductBulkApiInput
      • Email
      • ProductKitComponentApiInput
      • Error
      • ProductKitComponentBulkApiInput
      • ProductKitComponentCrossProductBulkApiInput
      • ProductSkuCrossProductBulkApiInput
      • Promotion
      • PromotionPagedResults
      • REWARD_APPLY
      • RolePermission
      • ORDER_STATUS
      • Section
      • OrderBatchStatusApiInput
      • Selection
      • OrderBatchStatusBulkApiInput
      • VISIBILITY
      • OrdersConnection
      • PRODUCT_SKU_STATUS_RAW
      • PersonApiInput
      • PersonBulkApiInput
      • PersonRule
      • PersonRuleApiInput
      • PersonTypeAssociation
      • PersonTypeAssociationApiInput
      • PersonsConnection
      • Phone
      • PriceAssociatedProductSkuMutation
      • PriceZonePagedResults
      • PricingBulkApiInput
      • PricingPagedResults
      • Product
      • ProductApiInput
      • ProductAssociation
      • ProductAssociationApiInput
      • ProductBulkApiInput
      • ProductHighlight
      • ProductHighlightByNameApiInput
      • ProductHighlightByNameResult
      • ProductHighlightPagedResults
      • ProductHighlightProductsApiInput
      • ProductOptionApiInput
      • ProductPagedResults
      • ProductRule
      • ProductRuleApiInput
      • ProductSkuBulkApiInput
      • SelectionPagedResults
      • VALIDATION_STATUS
      • ValidationProblemDetails
      • VendorApiInput
      • VendorBulkApiInput
      • VendorBulkItemApiInput
      • VendorPagedResults
      • WarehouseApiInput
      • WarehouseBulkApiInput
      • WarehouseBulkDistributorApiInput
      • WarehouseBulkItemApiInput
      • WarehousePagedResults
      • WarehouseSkuId

    Getting an API token

    Every request to the Marketplace API carries a token. You create tokens yourself in the Admin portal: there is no client id or secret to manage, only the token.

    Who can manage tokens#

    The API token management page is shown to users whose role has the Admin Tools permission:
    View shows the page and lets the user copy any token on it.
    Edit also lets the user create, rename, deactivate and delete tokens.
    Anyone with either can copy every token on the page, so give Admin Tools only to the people who look after your integrations.

    Create a token#

    1.
    Sign in to the Admin portal for the company the integration will use. A token works only in the company it was created in.
    2.
    Open Admin tools in the menu, then API token management under System.
    3.
    Select Create new token. API token management.jpg
    4.
    Enter a Description that names the integration and who owns it, for example "ERP order export – IT team", and select Generate API token. Create new API token.jpg
    5.
    Copy the token from the New API token generated dialog with the copy button. Created new API token.jpg
    6.
    Store it in your integration's secrets store, such as a key vault or your platform's encrypted settings. Never put it in source code.
    The token can be copied again later from the API token column of the list, so a lost copy doesn't mean a new token.

    Make a first call#

    Send the token in the Authorization header of every request:
    A working token answers 200 with the first vendor:
    {
      "pagination": {
        "endCursor": "MA==",
        "startCursor": "MA==",
        "hasNextPage": true,
        "hasPreviousPage": false,
        "totalRecords": 431,
        "resultsPerPage": 1
      },
      "items": [
        { "id": "50876", "name": "MISS LOS LLC", "status": "ACTIVE" }
      ]
    }
    A 401 means the token is missing, mistyped, expired, deactivated or deleted. Check that the header reads Bearer, a space, then the whole token.

    Keep a token working#

    A token lasts 365 days. The Expiration date column shows when it ends, and its Status shows Expired after that. Create the replacement, switch your integration to it, then delete the old one.
    Use one token per integration, so you can stop one without breaking the others.
    A token belongs to one company. A test company and your live company each need their own.

    Stop a token#

    Deactivate it to stop it working for now: select the token's description, set API token status to Inactive, and select Update details. Set it back to Active to use it again.
    Delete it to revoke it for good: select the bin icon on its row, then Delete API token. It can't be restored.
    Delete API token.jpg
    Either takes effect from the next request.
    If a token leaks, delete it straight away, create a new one, and switch your integration to it. The token's Last used date shows whether it was used after it leaked; it is updated about once an hour while the token is in use.
    Never send a token by email, in a chat or in a support ticket.
    Modified at 2026-11-17 01:58:13
    Next
    Introduction
    Built with