API reference
The complete verified operational catalogue: 41 paginated read collections and 79 mutations.
InventoryGET /slabsview_slabmaterial_id, warehouse_id, location_id, bundle_id, status, barcodeInventoryGET /materialsview_slabactive, codeInventoryGET /warehousesview_slabactive, codeInventoryGET /locationsview_slabwarehouse_id, active, codeInventoryGET /variantsview_slabmaterial_id, activeInventoryGET /lotsview_slabmaterial_id, statusInventoryGET /bundlesview_slabmaterial_id, lot_id, statusInventoryGET /remnantsview_slabparent_slab_id, warehouse_id, statusInventoryGET /movementsview_slabitem_type, item_id, movement_typePurchasingGET /suppliersview_slab_purchasingactivePurchasingGET /supplier-contactsview_slab_purchasingsupplier_id, activePurchasingGET /supplier-materialsview_slab_purchasingsupplier_id, material_idPurchasingGET /purchase-ordersview_slab_purchasingsupplier_id, statusPurchasingGET /purchase-order-itemsview_slab_purchasingpurchase_order_id, material_idLogisticsGET /shipmentsview_slab_logisticspurchase_order_id, statusLogisticsGET /containersview_slab_logisticsshipment_id, statusLogisticsGET /shipment-itemsview_slab_logisticsshipment_id, container_idLogisticsGET /receiptsview_slab_logisticsshipment_id, warehouse_idLogisticsGET /receipt-itemsview_slab_logisticsreceipt_id, shipment_item_id, slab_idLogisticsGET /receiving-exceptionsview_slab_logisticsshipment_id, statusCostsGET /landed-costsview_slab_costshipment_id, statusCostsGET /landed-cost-componentsview_slab_costlanded_cost_idCostsGET /landed-cost-allocationsview_slab_costlanded_cost_id, slab_idSales operationsGET /projectsview_slab_salesclient_id, status, salesperson_idSales operationsGET /selectionsview_slab_salesproject_id, statusSales operationsGET /selection-itemsview_slab_salesselection_id, slab_idSales operationsGET /reservationsview_slab_salesproject_id, statusSales operationsGET /reservation-itemsview_slab_salesreservation_id, slab_idSales operationsGET /quote-linksview_slab_salesproject_id, reservation_idSales operationsGET /quote-link-itemsview_slab_salesquote_link_id, slab_idSales operationsGET /allocationsview_slab_salesproject_id, reservation_id, statusSales operationsGET /allocation-itemsview_slab_salesallocation_id, slab_idTransfers & stocktakesGET /transfersmanage_slab_transferstatus, from_warehouse_id, to_warehouse_idTransfers & stocktakesGET /transfer-itemsmanage_slab_transfertransfer_id, slab_idTransfers & stocktakesGET /stocktakesmanage_slab_stocktakewarehouse_id, statusTransfers & stocktakesGET /stocktake-itemsmanage_slab_stocktakestocktake_id, slab_idFulfilment & returnsGET /fulfilmentsview_slab_fulfilmentallocation_id, statusFulfilment & returnsGET /fulfilment-itemsview_slab_fulfilmentfulfilment_id, slab_id, statusFulfilment & returnsGET /returnsview_slab_fulfilmentfulfilment_item_id, statusFulfilment & returnsGET /fulfilment-proofsview_slab_fulfilmentfulfilment_id, kindSales operationsGET /product-linksview_slab_salesmaterial_id, engine
InventoryPOST /slabsadd_slabslab_number barcode material_id material_variant_id lot_id bundle_id length_mm width_mm thickness_mm finish grade country_of_origin warehouse_id location_id status list_price selling_price website_visible notes supplier_cost landed_costInventoryPUT /slabs/{id}edit_slabslab_number barcode material_id material_variant_id lot_id bundle_id length_mm width_mm thickness_mm finish grade country_of_origin warehouse_id location_id status list_price selling_price website_visible notes supplier_cost landed_costInventoryDELETE /slabs/{id}delete_slabEmpty JSON object {}InventoryPOST /slabs/{id}/remnantsmanage_slab_inventorypiecesInventoryPUT /remnants/{id}manage_slab_inventorywarehouse_id location_id status notesInventoryPOST /materialsadd_slabname code description default_thickness_mm website_visible active material_type brand collection country_of_origin default_finish primary_colour secondary_colour pattern slugInventoryPUT /materials/{id}edit_slabname code description default_thickness_mm website_visible active material_type brand collection country_of_origin default_finish primary_colour secondary_colour pattern slugInventoryPOST /warehousesmanage_slab_warehousename code address city region postal_code country activeInventoryPUT /warehouses/{id}manage_slab_warehousename code address city region postal_code country activeInventoryPOST /locationsmanage_slab_warehousewarehouse_id code name type active parent_idInventoryPUT /locations/{id}manage_slab_warehousewarehouse_id code name type active parent_idInventoryPOST /variantsadd_slabmaterial_id name code thickness_mm finish activeInventoryPUT /variants/{id}edit_slabmaterial_id name code thickness_mm finish activeInventoryPOST /lotsadd_slabmaterial_id lot_number block_number country_of_origin quarry_reference received_date statusInventoryPUT /lots/{id}edit_slabmaterial_id lot_number block_number country_of_origin quarry_reference received_date statusInventoryPOST /bundlesadd_slabmaterial_id lot_id bundle_number thickness_mm finish warehouse_id location_id statusInventoryPUT /bundles/{id}edit_slabmaterial_id lot_id bundle_number thickness_mm finish warehouse_id location_id statusInventoryPOST /bundles/{id}/receivemanage_slab_inventoryquantity length_mm width_mm thickness_mm material_variant_id warehouse_id location_id supplier_cost landed_costPurchasingPOST /suppliersmanage_slab_purchasingname email phone address country currency_id payment_terms notes activePurchasingPUT /suppliers/{id}manage_slab_purchasingname email phone address country currency_id payment_terms notes activePurchasingPOST /suppliers/{id}/contactsmanage_slab_purchasingname email phone position active contact_idPurchasingPOST /suppliers/{id}/materialsmanage_slab_purchasingmaterial_id supplier_sku lead_days notesPurchasingPOST /purchase-ordersmanage_slab_purchasingsupplier_id supplier_reference order_date expected_ship_date expected_arrival_date currency_id exchange_rate exchange_rate_date discount tax_rate notes itemsPurchasingPUT /purchase-orders/{id}manage_slab_purchasingsupplier_id supplier_reference order_date expected_ship_date expected_arrival_date currency_id exchange_rate exchange_rate_date discount tax_rate notes itemsPurchasingPOST /purchase-orders/{id}/approveapprove_slab_purchasingEmpty JSON object {}PurchasingPOST /purchase-orders/{id}/sentmanage_slab_purchasingEmpty JSON object {}PurchasingPOST /purchase-orders/{id}/cancelmanage_slab_purchasingEmpty JSON object {}PurchasingPOST /purchase-orders/{id}/closemanage_slab_purchasingEmpty JSON object {}LogisticsPOST /shipmentsmanage_slab_logisticspurchase_order_id supplier_reference incoterm origin_country etd eta local_delivery_date warehouse_arrival_date customs_status mpi_status customs_reference local_carrier notesLogisticsPUT /shipments/{id}manage_slab_logisticspurchase_order_id supplier_reference incoterm origin_country etd eta local_delivery_date warehouse_arrival_date customs_status mpi_status customs_reference local_carrier notesLogisticsPOST /shipments/{id}/containersmanage_slab_logisticscontainer_id container_number container_type seal_number shipping_line vessel voyage port_loading port_discharge etd etaLogisticsPOST /shipments/{id}/itemsmanage_slab_logisticscontainer_id purchase_order_item_id expected_quantity lot_id weight_kgLogisticsPOST /shipments/{id}/remove-itemmanage_slab_logisticsitem_idLogisticsPOST /shipments/{id}/remove-containermanage_slab_logisticscontainer_idLogisticsPOST /shipments/{id}/reopenmanage_slab_logisticsEmpty JSON object {}LogisticsPOST /shipments/{id}/bookmanage_slab_logisticsEmpty JSON object {}LogisticsPOST /shipments/{id}/departmanage_slab_logisticsdateLogisticsPOST /shipments/{id}/arrivemanage_slab_logisticsdateLogisticsPOST /shipments/{id}/completemanage_slab_logisticsEmpty JSON object {}LogisticsPOST /shipments/{id}/cancelmanage_slab_logisticsEmpty JSON object {}LogisticsPOST /shipments/{id}/receivereceive_slab_shipmentscontainer_id warehouse_id location_id received_date notes itemsLogisticsPOST /receiving-exceptions/{id}/resolvemanage_slab_logisticsresolutionCostsPOST /shipments/{id}/landed-costsmanage_slab_landed_costallocation_method componentsCostsPOST /shipments/{id}/post-landed-costsapprove_slab_landed_costrevision manualSales operationsPOST /projectsmanage_slab_projectsname client_id crm_account_id crm_contact_id crm_opportunity_id core_project_id salesperson_id project_type status address required_date architect builder fabricator notesSales operationsPUT /projects/{id}manage_slab_projectsname client_id crm_account_id crm_contact_id crm_opportunity_id core_project_id salesperson_id project_type status address required_date architect builder fabricator notesSales operationsPOST /projects/{id}/selectionsmanage_slab_selectionsselection_id name notes slab_idsSales operationsPOST /reservationsmanage_slab_reservationsproject_id selection_id slab_ids hold_type expires_at reason notesSales operationsPOST /reservations/{id}/releasemanage_slab_reservationsreason expires_atSales operationsPOST /reservations/{id}/cancelmanage_slab_reservationsreason expires_atSales operationsPOST /reservations/{id}/extendmanage_slab_reservationsreason expires_atSales operationsPOST /reservations/{id}/quote-linkmanage_slab_quotesengine quote_id mappingSales operationsPOST /reservations/{id}/allocatemanage_slab_allocationsquote_link_idSales operationsPOST /allocations/{id}/cancelmanage_slab_allocationsreasonTransfers & stocktakesPOST /transfersmanage_slab_transferfrom_warehouse_id to_warehouse_id to_location_id slab_ids notesTransfers & stocktakesPOST /transfers/{id}/approveapprove_slab_transferEmpty JSON object {}Transfers & stocktakesPOST /transfers/{id}/pickmanage_slab_transferEmpty JSON object {}Transfers & stocktakesPOST /transfers/{id}/dispatchmanage_slab_transferEmpty JSON object {}Transfers & stocktakesPOST /transfers/{id}/receivemanage_slab_transferEmpty JSON object {}Transfers & stocktakesPOST /transfers/{id}/cancelmanage_slab_transferEmpty JSON object {}Transfers & stocktakesPOST /stocktakesmanage_slab_stocktakewarehouse_id location_id notesTransfers & stocktakesPOST /stocktakes/{id}/startmanage_slab_stocktakeEmpty JSON object {}Transfers & stocktakesPOST /stocktakes/{id}/reviewmanage_slab_stocktakeEmpty JSON object {}Transfers & stocktakesPOST /stocktakes/{id}/reopenmanage_slab_stocktakeEmpty JSON object {}Transfers & stocktakesPOST /stocktakes/{id}/approveapprove_slab_stocktakeEmpty JSON object {}Transfers & stocktakesPOST /stocktakes/{id}/cancelmanage_slab_stocktakeEmpty JSON object {}Transfers & stocktakesPOST /stocktakes/{id}/countmanage_slab_stocktakecode location_id reasonTransfers & stocktakesPOST /stocktakes/{id}/annotatemanage_slab_stocktakeitem_id reason countedFulfilment & returnsPOST /allocations/{id}/fulfilmentmanage_slab_fulfilmentcore_order_id delivery_type recipient address required_date notesFulfilment & returnsPOST /fulfilments/{id}/pickpick_slab_orderscode undoFulfilment & returnsPOST /fulfilments/{id}/dispatchdispatch_slab_ordersdriver carrier vehicle item_idsFulfilment & returnsPOST /fulfilments/{id}/deliverdeliver_slab_ordersitem_ids received_by noteFulfilment & returnsPOST /fulfilments/{id}/proofsdeliver_slab_ordersfilename content_base64 kindFulfilment & returnsPOST /fulfilments/{id}/loading-photodispatch_slab_ordersfilename content_base64Fulfilment & returnsPOST /fulfilments/{id}/cancelmanage_slab_fulfilmentreasonFulfilment & returnsPOST /fulfilment-items/{id}/returnmanage_slab_returnsreasonFulfilment & returnsPOST /returns/{id}/receivemanage_slab_returnswarehouse_id location_idFulfilment & returnsPOST /returns/{id}/inspectapprove_slab_returnsdisposition reasonSales operationsPOST /product-linksmanage_slab_product_linksmaterial_id material_variant_id engine product_id