Cin7 Core

App · 24 actions

Manage products, stock, customers, suppliers, sales and purchases in Cin7 Core (formerly DEAR Inventory).

Actions

ActionWhat it does
Add a line to a purchase orderAdd a product to a purchase's draft order, keeping the lines it already has.
Add a line to a sale orderAdd a product to a sale's draft order, keeping the lines it already has.
Create a customerAdd a customer to Cin7 Core.
Create a productAdd a product or service to Cin7 Core.
Create a purchaseStart a purchase from a supplier.
Create a saleStart a sale for a customer.
Create a supplierAdd a supplier to Cin7 Core.
Get a customerGet one customer, with their addresses and contacts.
Get a productGet one product, with its suppliers and reorder levels.
Get a purchaseGet one purchase with its order, receipts and invoices.
Get a saleGet one sale with its order, invoices and fulfilments.
Get accountGet the Cin7 Core company this connection reaches: its name, base currency and time zone.
Get stock levelsGet how many of each product are on hand, allocated, available and on order, by location.
List customersList customers, optionally by name, contact or when they last changed.
List locationsList the locations (warehouses) stock is kept in.
List productsList products, optionally by name, SKU or when they last changed.
List purchasesList purchases, optionally by search words, status or when they last changed.
List salesList sales, optionally by search words, status or when they were created or changed.
List suppliersList suppliers, optionally by name or when they last changed.
Update a customerChange a customer's details.
Update a productChange a product's details.
Update a supplierChange a supplier's details.
Void or undo a purchaseVoid a purchase for good, or undo it back to a draft.
Void or undo a saleVoid a sale for good, or undo it back to a draft.

Add a line to a purchase order

Add a product to a purchase's draft order, keeping the lines it already has.

Inputs

Purchase IDpurchase_idtextRequired
The purchase's ID. Create a purchase returns it as ID.
Productproduct_idtextRequired
The product to add.
QuantityquantitynumberRequired
How many.At least 1.
PricepricenumberRequired
Price for one, in the supplier's currency.At least 0.
Tax ruletax_ruletextRequired
The tax rule for this line.
TaxtaxnumberRequired
The line's tax amount, in the order's currency. Enter 0 if the line has no tax.At least 0.
Discountdiscountnumber
Discount in percent, from 0 to 100.From 0 to 100.
Supplier SKUsupplier_skutext
The supplier's own code for the product.
Commentcommenttext
A comment on the line.
Authoriseauthorisetrue/false
On to authorise the order once the line is added. Off keeps it a draft you can add more lines to.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Lines": [
      {
        "Comment": "example",
        "Discount": 1,
        "Name": "example",
        "Price": 1,
        "ProductID": "example",
        "Quantity": 1,
        "SKU": "example",
        "Tax": 1,
        "TaxRule": "example",
        "Total": 1
      }
    ],
    "Memo": "example",
    "Status": "example",
    "Tax": 1,
    "Total": 1,
    "TotalBeforeTax": 1
  }
}

Add a line to a sale order

Add a product to a sale's draft order, keeping the lines it already has.

Inputs

Sale IDsale_idtextRequired
The sale's ID. Create a sale returns it as ID.
Productproduct_idtextRequired
The product to add.
QuantityquantitynumberRequired
How many.At least 1.
PricepricenumberRequired
Price for one, in the customer's currency.At least 0.
Tax ruletax_ruletextRequired
The tax rule for this line.
TaxtaxnumberRequired
The line's tax amount, in the order's currency. Enter 0 if the line has no tax.At least 0.
Discountdiscountnumber
Discount in percent, from 0 to 100.From 0 to 100.
Commentcommenttext
A comment on the line.
Authoriseauthorisetrue/false
On to authorise the order once the line is added. Off keeps it a draft you can add more lines to.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Lines": [
      {
        "Comment": "example",
        "Discount": 1,
        "Name": "example",
        "Price": 1,
        "ProductID": "example",
        "Quantity": 1,
        "SKU": "example",
        "Tax": 1,
        "TaxRule": "example",
        "Total": 1
      }
    ],
    "Memo": "example",
    "Status": "example",
    "Tax": 1,
    "Total": 1,
    "TotalBeforeTax": 1
  }
}

Create a customer

Add a customer to Cin7 Core.

Inputs

NamenametextRequired
The customer's name. It must be unique.
CurrencycurrencytextRequired
The customer's currency code, such as USD.
Payment termpayment_termtextRequired
The payment term.
Tax ruletax_ruletextRequired
The tax rule for sales to them.
Accounts receivable accountreceivable_accounttextRequired
The accounts receivable account.
Revenue accountrevenue_accounttextRequired
The sales revenue account.
Locationlocationtext
The location their orders ship from.
Price tierprice_tiertext
The price tier name, such as Tier 1.
Contact namecontact_nametext
Name of the main contact.
Contact emailcontact_emailtext
Email of the main contact.
Contact phonecontact_phonetext
Phone of the main contact.
Commentscommentstext
Notes about the customer.
Tagstagstext
Tags, separated by commas.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "CustomerList": [
      {
        "AccountReceivable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Location": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "PriceTier": "example",
        "RevenueAccount": "example",
        "Status": "example",
        "Tags": "example",
        "TaxRule": "example"
      }
    ],
    "Page": 1,
    "Total": 1
  }
}

Create a product

Add a product or service to Cin7 Core.

Inputs

SKUskutextRequired
The product's SKU. It must be unique.
NamenametextRequired
The product's name.
CategorycategorytextRequired
The product's category.
Unit of measureunittextRequired
The unit it is sold in, such as Item.
Typetypetext
Stock for physical goods Cin7 Core counts, Service for anything else.One of: Stock, Service. Default: Stock.
Costing methodcosting_methodtext
How Cin7 Core values the stock.One of: FIFO, Special - Batch, Special - Serial Number, FIFO - Serial Number, FIFO - Batch, FEFO - Batch, FEFO - Serial Number. Default: FIFO.
Pricepricenumber
Sale price for price tier 1.At least 0.
Barcodebarcodetext
The product's barcode.
Brandbrandtext
The brand name.
Short descriptionshort_descriptiontext
A short description.
Descriptiondescriptiontext
The full description.
Default locationdefault_locationtext
The location it is usually kept in.
Reorder pointreorder_pointnumber
Reorder once fewer than this many are available.At least 0.
Reorder quantityreorder_quantitynumber
How many to order when reordering.At least 0.
Weightweightnumber
Weight in kilograms.At least 0.
Tagstagstext
Tags, separated by commas.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "Products": [
      {
        "AverageCost": 1,
        "Barcode": "example",
        "Brand": "example",
        "Category": "example",
        "CostingMethod": "example",
        "DefaultLocation": "example",
        "Description": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "MinimumBeforeReorder": 1,
        "Name": "example",
        "PriceTier1": 1,
        "ReorderQuantity": 1,
        "SKU": "example",
        "ShortDescription": "example",
        "Status": "example",
        "Tags": "example",
        "Type": "example",
        "UOM": "example"
      }
    ],
    "Total": 1
  }
}

Create a purchase

Start a purchase from a supplier. Add products to it with Add a line to a purchase order.

Inputs

Suppliersupplier_idtextRequired
The supplier.
LocationlocationtextRequired
The location the stock goes to.
Approachapproachtext
Receive the stock first, or the invoice first.One of: STOCK, INVOICE. Default: STOCK.
Tax ruletax_ruletext
The purchase's tax rule. Leave empty for the supplier's.
Required byrequired_bydate
When the stock is needed.
Notenotetext
A note on the purchase.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Approach": "example",
    "ID": "example",
    "LastUpdatedDate": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "OrderDate": "example",
    "OrderNumber": "example",
    "RequiredBy": "example",
    "Status": "example",
    "Supplier": "example",
    "SupplierID": "example",
    "TaxRule": "example",
    "Type": "example"
  }
}

Create a sale

Start a sale for a customer. Add products to it with Add a line to a sale order.

Inputs

Customercustomer_idtextRequired
The customer.
LocationlocationtextRequired
The location to ship stock from.
Customer referencecustomer_referencetext
The customer's own reference, such as their purchase order number.
Tax ruletax_ruletext
The sale's tax rule. Leave empty for the customer's.
Ship byship_bydate
When it has to ship.
Notenotetext
A note on the sale.
External IDexternal_idtext
Your own ID for the sale, to find it again with List sales.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Customer": "example",
    "CustomerID": "example",
    "CustomerReference": "example",
    "ExternalID": "example",
    "ID": "example",
    "LastModifiedOn": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "SaleOrderDate": "example",
    "ShipBy": "example",
    "Status": "example",
    "TaxRule": "example",
    "Terms": "example",
    "Type": "example"
  }
}

Create a supplier

Add a supplier to Cin7 Core.

Inputs

NamenametextRequired
The supplier's name.
CurrencycurrencytextRequired
The supplier's currency code, such as USD.
Payment termpayment_termtextRequired
The payment term.
Tax ruletax_ruletextRequired
The tax rule for purchases from them.
Accounts payable accountpayable_accounttextRequired
The accounts payable account.
Contact namecontact_nametext
Name of the main contact.
Contact emailcontact_emailtext
Email of the main contact.
Contact phonecontact_phonetext
Phone of the main contact.
Commentscommentstext
Notes about the supplier.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "SupplierList": [
      {
        "AccountPayable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "Status": "example",
        "TaxRule": "example"
      }
    ],
    "Total": 1
  }
}

Get a customer

Get one customer, with their addresses and contacts.

Inputs

Customercustomer_idtextRequired
The customer.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "CustomerList": [
      {
        "AccountReceivable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Location": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "PriceTier": "example",
        "RevenueAccount": "example",
        "Status": "example",
        "Tags": "example",
        "TaxRule": "example"
      }
    ],
    "Page": 1,
    "Total": 1
  }
}

Get a product

Get one product, with its suppliers and reorder levels.

Inputs

Productproduct_idtextRequired
The product.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "Products": [
      {
        "AverageCost": 1,
        "Barcode": "example",
        "Brand": "example",
        "Category": "example",
        "CostingMethod": "example",
        "DefaultLocation": "example",
        "Description": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "MinimumBeforeReorder": 1,
        "Name": "example",
        "PriceTier1": 1,
        "ReorderQuantity": 1,
        "SKU": "example",
        "ShortDescription": "example",
        "Status": "example",
        "Tags": "example",
        "Type": "example",
        "UOM": "example"
      }
    ],
    "Total": 1
  }
}

Get a purchase

Get one purchase with its order, receipts and invoices.

Inputs

Purchase IDpurchase_idtextRequired
The purchase's ID. List purchases returns it as ID.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Approach": "example",
    "ID": "example",
    "LastUpdatedDate": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "OrderDate": "example",
    "OrderNumber": "example",
    "RequiredBy": "example",
    "Status": "example",
    "Supplier": "example",
    "SupplierID": "example",
    "TaxRule": "example",
    "Type": "example"
  }
}

Get a sale

Get one sale with its order, invoices and fulfilments.

Inputs

Sale IDsale_idtextRequired
The sale's ID. List sales returns it as SaleID.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Customer": "example",
    "CustomerID": "example",
    "CustomerReference": "example",
    "ExternalID": "example",
    "ID": "example",
    "LastModifiedOn": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "SaleOrderDate": "example",
    "ShipBy": "example",
    "Status": "example",
    "TaxRule": "example",
    "Terms": "example",
    "Type": "example"
  }
}

Get account

Get the Cin7 Core company this connection reaches: its name, base currency and time zone.

Inputs

None.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Company": "example",
    "Currency": "example",
    "DefaultSaleTaxRuleName": "example",
    "TimeZone": "example"
  }
}

Get stock levels

Get how many of each product are on hand, allocated, available and on order, by location.

Inputs

Productproduct_idtext
Only this product.
SKUskutext
Only the product with this SKU.
Namenametext
Only products whose name starts with this.
Locationlocationtext
Only stock at this location.
Categorycategorytext
Only products in this category.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "ProductAvailabilityList": [
      {
        "Allocated": 1,
        "Available": 1,
        "Batch": "example",
        "Bin": "example",
        "ID": "example",
        "InTransit": 1,
        "Location": "example",
        "Name": "example",
        "OnHand": 1,
        "OnOrder": 1,
        "SKU": "example"
      }
    ],
    "Total": 1
  }
}

List customers

List customers, optionally by name, contact or when they last changed.

Inputs

Namenametext
Only customers whose name starts with this.
Contactcontacttext
Only customers with a contact whose name starts with this, or whose email is this.
Modified sincemodified_sincedate and time
Only customers changed at or after this time.
Include deprecatedinclude_deprecatedtrue/false
Include deprecated customers too.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "CustomerList": [
      {
        "AccountReceivable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Location": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "PriceTier": "example",
        "RevenueAccount": "example",
        "Status": "example",
        "Tags": "example",
        "TaxRule": "example"
      }
    ],
    "Page": 1,
    "Total": 1
  }
}

List locations

List the locations (warehouses) stock is kept in.

Inputs

Namenametext
Only locations whose name starts with this.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "LocationList": [
      {
        "Deprecated": true,
        "ID": "example",
        "IsDefault": true,
        "Name": "example"
      }
    ],
    "Page": 1,
    "Total": 1
  }
}

List products

List products, optionally by name, SKU or when they last changed.

Inputs

Namenametext
Only products whose name contains this.
SKUskutext
Only products whose SKU contains this.
Modified sincemodified_sincedate and time
Only products changed at or after this time.
Include deprecatedinclude_deprecatedtrue/false
Include deprecated products too.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "Products": [
      {
        "AverageCost": 1,
        "Barcode": "example",
        "Brand": "example",
        "Category": "example",
        "CostingMethod": "example",
        "DefaultLocation": "example",
        "Description": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "MinimumBeforeReorder": 1,
        "Name": "example",
        "PriceTier1": 1,
        "ReorderQuantity": 1,
        "SKU": "example",
        "ShortDescription": "example",
        "Status": "example",
        "Tags": "example",
        "Type": "example",
        "UOM": "example"
      }
    ],
    "Total": 1
  }
}

List purchases

List purchases, optionally by search words, status or when they last changed.

Inputs

Searchsearchtext
Words to find in the order number, supplier or invoice number.
Updated sinceupdated_sincedate and time
Only purchases changed after this time.
Statusstatustext
Only purchases in this state.One of: DRAFT, ORDERING, ORDERED, RECEIVING, RECEIVED, INVOICED, CREDITED, COMPLETED, VOIDED.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "PurchaseList": [
      {
        "ID": "example",
        "InvoiceAmount": 1,
        "InvoiceNumber": "example",
        "LastUpdatedDate": "example",
        "OrderDate": "example",
        "OrderNumber": "example",
        "OrderStatus": "example",
        "PaidAmount": 1,
        "RequiredBy": "example",
        "Status": "example",
        "Supplier": "example",
        "SupplierID": "example"
      }
    ],
    "Total": 1
  }
}

List sales

List sales, optionally by search words, status or when they were created or changed.

Inputs

Searchsearchtext
Words to find in the order number, customer, invoice number or customer reference.
Created sincecreated_sincedate and time
Only sales created after this time.
Updated sinceupdated_sincedate and time
Only sales changed after this time.
Statusstatustext
Only sales in this state.One of: ESTIMATING, ESTIMATED, ORDERING, ORDERED, BACKORDERED, PICKING, PICKED, PACKING, PACKED, SHIPPING, and 5 more.
External IDexternal_idtext
Only the sale with this external ID.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "SaleList": [
      {
        "CombinedInvoiceStatus": "example",
        "CombinedPaymentStatus": "example",
        "CombinedShippingStatus": "example",
        "Customer": "example",
        "CustomerID": "example",
        "CustomerReference": "example",
        "ExternalID": "example",
        "InvoiceAmount": 1,
        "InvoiceNumber": "example",
        "OrderDate": "example",
        "OrderNumber": "example",
        "OrderStatus": "example",
        "PaidAmount": 1,
        "SaleID": "example",
        "Status": "example",
        "Updated": "example"
      }
    ],
    "Total": 1
  }
}

List suppliers

List suppliers, optionally by name or when they last changed.

Inputs

Namenametext
Only suppliers whose name starts with this.
Modified sincemodified_sincedate and time
Only suppliers changed at or after this time.
Include deprecatedinclude_deprecatedtrue/false
Include deprecated suppliers too.
Pagepagenumber
Which page of results, starting at 1.At least 1.
Limitlimitnumber
How many to return on a page, up to 1000. Cin7 Core's default is 100.From 1 to 1000.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "SupplierList": [
      {
        "AccountPayable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "Status": "example",
        "TaxRule": "example"
      }
    ],
    "Total": 1
  }
}

Update a customer

Change a customer's details. Only the fields you fill in change.

Inputs

Customercustomer_idtextRequired
The customer.
Namenametext
The new name.
Payment termpayment_termtext
The new payment term.
Tax ruletax_ruletext
The new tax rule.
Locationlocationtext
The new location their orders ship from.
Price tierprice_tiertext
The new price tier name.
Commentscommentstext
The new notes.
Tagstagstext
The new tags, separated by commas.
Statusstatustext
Active, or Deprecated to retire it. Cin7 Core can't delete it.One of: Active, Deprecated.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "CustomerList": [
      {
        "AccountReceivable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Location": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "PriceTier": "example",
        "RevenueAccount": "example",
        "Status": "example",
        "Tags": "example",
        "TaxRule": "example"
      }
    ],
    "Page": 1,
    "Total": 1
  }
}

Update a product

Change a product's details. Only the fields you fill in change.

Inputs

Productproduct_idtextRequired
The product.
Namenametext
The new name.
SKUskutext
The new SKU.
Categorycategorytext
The new category.
Pricepricenumber
The new sale price for price tier 1.At least 0.
Barcodebarcodetext
The new barcode.
Short descriptionshort_descriptiontext
The new short description.
Descriptiondescriptiontext
The new full description.
Reorder pointreorder_pointnumber
Reorder once fewer than this many are available.At least 0.
Reorder quantityreorder_quantitynumber
How many to order when reordering.At least 0.
Tagstagstext
The new tags, separated by commas.
Statusstatustext
Active, or Deprecated to retire it. Cin7 Core can't delete it.One of: Active, Deprecated.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "Products": [
      {
        "AverageCost": 1,
        "Barcode": "example",
        "Brand": "example",
        "Category": "example",
        "CostingMethod": "example",
        "DefaultLocation": "example",
        "Description": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "MinimumBeforeReorder": 1,
        "Name": "example",
        "PriceTier1": 1,
        "ReorderQuantity": 1,
        "SKU": "example",
        "ShortDescription": "example",
        "Status": "example",
        "Tags": "example",
        "Type": "example",
        "UOM": "example"
      }
    ],
    "Total": 1
  }
}

Update a supplier

Change a supplier's details. Only the fields you fill in change.

Inputs

Suppliersupplier_idtextRequired
The supplier.
Namenametext
The new name.
Payment termpayment_termtext
The new payment term.
Tax ruletax_ruletext
The new tax rule.
Commentscommentstext
The new notes.
Statusstatustext
Active, or Deprecated to retire it. Cin7 Core can't delete it.One of: Active, Deprecated.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Page": 1,
    "SupplierList": [
      {
        "AccountPayable": "example",
        "Comments": "example",
        "Contacts": [
          {
            "Default": true,
            "Email": "example",
            "ID": "example",
            "Name": "example",
            "Phone": "example"
          }
        ],
        "Currency": "example",
        "ID": "example",
        "LastModifiedOn": "example",
        "Name": "example",
        "PaymentTerm": "example",
        "Status": "example",
        "TaxRule": "example"
      }
    ],
    "Total": 1
  }
}

Void or undo a purchase

Void a purchase for good, or undo it back to a draft.

Inputs

Purchase IDpurchase_idtextRequired
The purchase's ID. List purchases returns it as ID.
Voidvoidtrue/falseRequired
On to void the purchase for good. Off to undo its authorisations back to a draft.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Approach": "example",
    "ID": "example",
    "LastUpdatedDate": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "OrderDate": "example",
    "OrderNumber": "example",
    "RequiredBy": "example",
    "Status": "example",
    "Supplier": "example",
    "SupplierID": "example",
    "TaxRule": "example",
    "Type": "example"
  }
}

Void or undo a sale

Void a sale for good, or undo it back to a draft.

Inputs

Sale IDsale_idtextRequired
The sale's ID. List sales returns it as SaleID.
Voidvoidtrue/falseRequired
On to void the sale for good. Off to undo its authorisations back to a draft.

Outputs

dataobject
The response from Cin7 Core.
Example output
{
  "data": {
    "Customer": "example",
    "CustomerID": "example",
    "CustomerReference": "example",
    "ExternalID": "example",
    "ID": "example",
    "LastModifiedOn": "example",
    "Location": "example",
    "Note": "example",
    "Order": {
      "Lines": [
        {
          "Comment": "example",
          "Discount": 1,
          "Name": "example",
          "Price": 1,
          "ProductID": "example",
          "Quantity": 1,
          "SKU": "example",
          "Tax": 1,
          "TaxRule": "example",
          "Total": 1
        }
      ],
      "Memo": "example",
      "Status": "example",
      "Tax": 1,
      "Total": 1,
      "TotalBeforeTax": 1
    },
    "SaleOrderDate": "example",
    "ShipBy": "example",
    "Status": "example",
    "TaxRule": "example",
    "Terms": "example",
    "Type": "example"
  }
}

On this page