Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Products

CreateUpdateProductByID

Creates or updates a product in Microbizz.

If a product with the given product id already exists, then the product will be overwritten.

If the product provided have a product id of 0, a new product will be created and a new product id will be provided.

Input

productproductThe product to create/update


Output

productproductThe product object as it is in Microbizz after the update

CreateUpdateProductByProductNumber

Creates or updates a product in Microbizz.

If a product with the given product number already exists, then the product will be overwritten.

If several products exists with the given product number, only one of these (unpredicted) will be overwritten.

If a product number isn't provided in the product object, the command will fail.

The product id in the input product object will be ignored.

Input

productproduct

The product to create/update

Output

productproductThe product object as it is in Microbizz after the update

GetProductByID

Get a product by their Microbizz product id

If no such product exist an empty collection will be returned.

Input

productidnumberThe Microbizz product id of the product to fetch
include_pricesbooleanGet prices even if these are disabled

Output

productscollection[ product ]A collection either empty if no products was found, or with exactly one element being the product.

GetProductByProductNumber

Get a product by their product number.

If no such product exist an empty collection will be returned.

If several products exists with the provided product number, only one of these (unpredicted) is returned.

Input

productnumberstringThe product number of the product to fetch
include_pricesbooleanGet prices even if these are disabled

Output

productscollection[ product ]A collection either empty if no products was found, or with exactly one element being the product.

GetProductsByLastChange

Get a collection of products changed since a given date and time.

Input

changedatedateReturn all products changed on or after the provided date.
changetimetimeIf this is provided only return products changed after the provided date and time.
resumekeystringIf a partial result is returned, provide the resumekey received along with the partial result, to get the rest of the entries
include_pricesbooleanGet prices even if these are disabled
ignoreclosedbooleanSkip products that are deleted
onlyfavoritesbooleanIf 1 then only get products that are the favorites of the current user
skip_deletedbooleanIf 1 then don't send deleted products

Output

productscollection[ product ]A collection of the relevant products, or an empty collection if no products were found.
resumekeystringSometimes the entire result cannot be returned because it's to large. In that case a resumekey is returned along with the results. Execute the command again with this resumekey to get the remaining results.

DeleteProductByID

Deletes a product by their Microbizz product id

The product is only deleted from the product catalog. Instances of the product used in offers and on customers are retained.

Input

productidnumberThe Microbizz product id of the product to delete

Output

None.--

CreateDirectOrder

Create a direct order / quotation.

Input

customeridnumberThe ID of the customer in Microbizz
linescollection[directorderline]The order lines
notestringA note to use for the quotation
deliverydatedateDelivery date for the quotation

There must be at least 1 order line.

Output

None--

GetProductGroups

Get all product groups. Notice that product groups can be nested, so a product group can be the "child" of another product group.

Input

inclchildrenboolSet to 0 to get only the "root" product groups, set to 1 to get all product groups.

Output

groupscollection[productgroup]All the product groups, each product group holds {id,title,parentid}


Prices

AssignIndividualPriceByProductNumber

Assigns an individual price to a given product identified by product number, to a given customer identified by a customer id.

If several products exists with the given product number, only one of these (unpredicted) will be assigned the individual price.

If the product or the customer doesn't exists, the command will still succeed, but nothing will happen.

Input

productnumberstringProduct number
customeridnumberId of the customer for which to assign the price
pricenumberIndividual price pr. unit in lowest local currency. (Typical danish ører)

Output

None--

RemoveIndividualPriceByProductNumber

Removes an individual price to a given product identified by product number, from a given customer identified by a customer id.

If neither the product, the customer nor the individual price exists, the command will still succeed, but nothing will happen.

Input

productnumberstringProduct number
customeridnumberId of the customer for which to remove any individual price. If this is omitted, then individual pricing will be removed for all customers.

Output

None--

...

CreateUpdateIndividualPricesByCustomerID

Update (or create) existing individual prices for a customer.

...

Input

pricessetNew prices per unit (in pence/cent/øre) hashed by product numbers
customeridnumberId of the customer for which to update individual prices.

...

allow_create

...

boolSet to 1 to create individual prices that do not already exist

Output

statssetInformation about the number of prices created/updated/skipped/not changed