Inventory

Suppliers

A Supplier represents a supplier of goods to an organisation.

get/inventory/suppliers

List Suppliers

listSuppliers

This endpoint retrieves a list of all the suppliers for the given organisation.

Query parameters

  • idsuuidoptional

    A comma-separated list of supplier IDs to retrieve.

  • site_iduuidrequired

    Filter suppliers by site.

  • archivedbooleanoptional

    Whether to include archived resources in the response. When true, archived resources are returned; when false or omitted, only non-archived resources are returned.

  • querystringoptional

    A search query to filter suppliers by. This will search the supplier name.

  • pageintegeroptional

    The page to retrieve results from

  • per_pageintegeroptional

    The number of results to return per page

Responses

  • 200

    The suppliers were successfully retrieved

  • 401

    The user is unauthenticated

post/inventory/suppliers

Create a Supplier

createSupplier

This endpoint creates a supplier for the given organisation.

Request body

  • namestringrequired

    Trading name of the inventory supplier, shown on purchase orders and supplier reports. Trimmed; 1-120 characters, must not contain HTML.

  • site_iduuidrequired

    Identifier of the site that owns this supplier record. Supplier records are scoped per site so each site can maintain its own supplier list, terms, and contact info.

Responses

  • 201

    The supplier was successfully retrieved

  • 401

    The user is unauthenticated

  • 403

    The authenticated user does not have permission.

  • 422

    The request didn't pass validation

get/inventory/suppliers/{supplierId}

Show a Supplier

getSupplier

This endpoint retrieves a single supplier for the given organisation.

Path parameters

Responses

  • 200

    The supplier was successfully retrieved

  • 401

    The user is unauthenticated

  • 404

    The resource couldn't be found

put/inventory/suppliers/{supplierId}

Update a Supplier

updateSupplier

This endpoint updates a single supplier for the given organisation.

Path parameters

Request body

  • namestringoptional

    Trading name of the inventory supplier, shown on purchase orders and supplier reports. Trimmed; 1-120 characters, must not contain HTML.

  • emailstringoptionalnullable

    An email address for the supplier.

  • phonestringoptionalnullable

    A phone number for the supplier.

  • address_1stringoptionalnullable

    The first line of the supplier's address.

  • address_2stringoptionalnullable

    The second line of the supplier's address.

  • citystringoptionalnullable

    The city part of the supplier's address.

  • countystringoptionalnullable

    The county part of the supplier's address.

  • countrystringoptionalnullable

    The country part of the supplier's address.

  • postcodestringoptionalnullable

    The ZIP or postal code part of the supplier's address.

Responses

  • 200

    The supplier was successfully retrieved

  • 401

    The user is unauthenticated

  • 403

    The authenticated user does not have permission.

  • 404

    The resource couldn't be found

  • 422

    The request didn't pass validation

delete/inventory/suppliers/{supplierId}

Archive a Supplier

deleteSupplier

This endpoint soft deletes a single supplier for the given organisation.

Path parameters

Responses

  • 204

    The supplier was successfully archived.

  • 401

    The user is unauthenticated

  • 403

    The authenticated user does not have permission.

  • 404

    The resource couldn't be found

post/inventory/suppliers/{supplierId}/copy

Copy a Supplier

actionSupplier

This endpoint copies an existing supplier by ID.

Path parameters

Request body

  • namestringrequired

    Name to give the duplicated supplier. Typically the source supplier's name with a "(copy)" suffix. Trimmed; 1-120 characters and must not contain HTML.

Responses

  • 200

    The supplier was successfully retrieved

  • 401

    The user is unauthenticated

  • 403

    The authenticated user does not have permission.

  • 404

    The resource couldn't be found

  • 422

    The request didn't pass validation

post/inventory/suppliers/{supplierId}/restore

Restore a Supplier

restoreSupplier

This endpoint restores an archived (soft-deleted) supplier by ID.

Path parameters

Responses

  • 200

    The supplier was successfully retrieved

  • 401

    The user is unauthenticated

  • 403

    The authenticated user does not have permission.

  • 404

    The resource couldn't be found

get/inventory/suppliers/{supplierId}/products

List products for a Supplier

listSupplierProducts

This endpoint retrieves a list of all the products for the given supplier.

Path parameters

Query parameters

  • pageintegeroptional

    The page to retrieve results from

  • per_pageintegeroptional

    The number of results to return per page

Responses

  • 200

    The supplier's products were successfully retrieved

  • 401

    The user is unauthenticated

  • 404

    The resource couldn't be found