Referencja powstaje automatycznie z publicznego schematu GraphQL przy każdym wydaniu dokumentacji, więc opisuje dokładnie to, co udostępnia API. Opisy operacji i pól są po angielsku, tak jak w schemacie. Każda operacja podaje wymagany zakres, stabilność i wersję Prynt, od której jest dostępna.
Zapytania
billingEntitiesBetareference:readThe print shop's own companies that invoice its orders (billing entities), one page at a time, with the total count: what `Order.billingEntityId`, `Client.defa…billingEntityBetareference:readOne billing entity by its identifier; null when there is no such entity.clientBetaclients:readOne client by its identifier; null when there is no such client.clientsBetaclients:readClients, one page at a time, with the total count.clientTagsBetaclients:readEvery tag the print shop marks clients with, by name.currenciesBetareference:readCurrencies the print shop sells in, in its display order: what `Order.currencyId`, `Client.defaultCurrencyId` and `ProductInvoice.currencyId` point at.currentApiKeyBetaThe API key this request was made with: its integration, the scopes it may use, when the key and the approval of the integration expire, and the rate limit.dieCutBetawarehouse:readOne die-cut by its identifier, archived or not; null when there is no such die-cut.dieCutsBetawarehouse:readDie-cuts in the warehouse, one page at a time, with the total count; archived ones only on request (`isArchived`) or when syncing.foilBetawarehouse:readOne foil by its identifier; null when there is no such foil.foilsBetawarehouse:readFoils in the warehouse with their stock, one page at a time, with the total count.machineBetareference:readOne machine by its identifier; null when there is no such machine.machinesBetareference:readMachines of the print shop, one page at a time, with the total count: what `Operation.machineId` and `Task.machineId` point at, decommissioned ones included (`…matricesBetawarehouse:readMatrices in the warehouse, one page at a time, with the total count; archived ones only on request (`isArchived`) or when syncing.matrixBetawarehouse:readOne matrix by its identifier, archived or not; null when there is no such matrix.operationBetaorders:readOne operation of an order by its identifier; null when there is none.operationsBetaorders:readOperations of the orders' elements, one page at a time, with the total count: the shop floor's work by machine, by where production stands (with the production…orderBetaorders:readOne order by its identifier; null when there is no such order.ordersBetaorders:readOrders, one page at a time, with the total count.paintBetawarehouse:readOne paint by its identifier; null when there is no such paint.paintsBetawarehouse:readPaints in the warehouse with their stock, one page at a time, with the total count.paperBetawarehouse:readOne paper by its identifier; null when there is no such paper.papersBetawarehouse:readPapers in the warehouse with their stock, one page at a time, with the total count.productBetaorders:readOne product of an order by its identifier; null when there is no such product.productInvoiceBetainvoices:readOne sales invoice of a product by its identifier; null when there is no such invoice.productInvoicesBetainvoices:readSales invoices of the products of orders, one page at a time, with the total count.purchaseInvoiceBetainvoices:readOne purchase invoice by its identifier; null when there is no such invoice.purchaseInvoicesBetainvoices:readPurchase invoices (from suppliers), one page at a time, with the total count.purchaseOrderBetawarehouse:readOne purchase order by its identifier; null when there is no such order.purchaseOrdersBetawarehouse:readPurchase orders to suppliers, one page at a time, with the total count.referenceDataBetareference:readEntries of one dictionary of the print shop (operation types, color profiles, product categories…), in its display order: what the `…TypeId`, `colorProfileId`…stockMovementsBetawarehouse:readMovements of paper, paint and foil stock — receipts (also purchase-order deliveries), issues, corrections and stock-take adjustments — one page at a time, with…stockTakeBetawarehouse:readOne stock take by its identifier; null when there is no such stock take.stockTakesBetawarehouse:readStock takes, one page at a time, with the total count; newest first unless sorted.supplierBetawarehouse:readOne supplier by its identifier; null when there is no such supplier.suppliersBetawarehouse:readSuppliers of warehouse materials, one page at a time, with the total count.taskBetaproduction:readOne production task by its identifier; null when there is no such task.tasksBetaproduction:readProduction tasks, one page at a time, with the total count: what the shop floor is doing on the operations of orders, with status and times.vatRatesBetareference:readVAT rates the print shop uses on products and invoices, in its display order.
Mutacje
addAdditionalCostBetaorders:writeAdds an additional cost (for example design work) to an order or to one of its products.assignClientTagBetaclients:writeGives a client a tag from `clientTags`.completeFileUploadBetafiles:writeConfirms that the content of a file started with `initiateFileUpload` was sent.createClientBetaclients:writeAdds a client — with its headquarters address and, for a person, a self contact — and, from an integration, the integration's own reference (`externalRef`).createClientAddressBetaclients:writeAdds an address to a client.createClientContactBetaclients:writeAdds a contact person to a client.createClientNoteBetaclients:writeWrites a CRM note about a client — a call, a meeting, an e-mail — with the caller as its author.createOrderBetaorders:writeCreates an order with its products (and their elements and operations), contact, delivery addresses, billing details and additional costs.createOrderPaymentBetaorders:writeRecords a payment received for an order, in the order currency.createProductBetaorders:writeAdds a product to an existing order that is not archived.createPurchaseOrderBetawarehouse:writeAdds a purchase order (status DRAFT) with its items and, from an integration, the integration's own reference (`externalRef`).createSupplierBetawarehouse:writeAdds a supplier.initiateFileUploadBetafiles:writeStarts uploading a file to an order or a product: records the file as pending and returns a signed URL to send its content to.receiveFoilBetawarehouse:writeReceives foil into stock outside purchase orders (for a delivery ordered in Prynt use `receivePurchaseOrder`): books a movement — with the price, supplier and…receivePaintBetawarehouse:writeReceives paint into stock outside purchase orders (for a delivery ordered in Prynt use `receivePurchaseOrder`): books a movement — with the price, supplier and…receivePaperBetawarehouse:writeReceives paper into stock outside purchase orders (for a delivery ordered in Prynt use `receivePurchaseOrder`): books a movement — with the price, supplier and…receivePurchaseOrderBetawarehouse:writeReceives a delivery against a SENT, CONFIRMED or PARTIALLY_RECEIVED purchase order (another status: PURCHASE_ORDER_NOT_RECEIVABLE): each item's received quanti…removeClientTagBetaclients:writeTakes a tag from a client (the tag itself stays).updateAdditionalCostBetaorders:writeChanges an additional cost of an order; refused for an archived order.updateClientBetaclients:writeChanges a client: a field left out keeps its value, null clears a field that may be empty.updateClientAddressBetaclients:writeChanges an address of a client: a field left out keeps its value, null clears an optional field.updateClientContactBetaclients:writeChanges a contact person: a field left out keeps its value, null clears a text field.updateClientNoteBetaclients:writeChanges a note.updateOperationBetaorders:writeChanges one operation of an element: fields left out keep their values, null clears only the fields that say so.updateOrderBetaorders:writeChanges an order: its fields, status, contact, delivery addresses or billing details.updateProductBetaorders:writeChanges a product: fields left out keep their values.updatePurchaseOrderBetawarehouse:writeChanges a purchase order that is neither RECEIVED nor CANCELLED: a field left out keeps its value, `items` replaces the whole item list.updatePurchaseOrderStatusBetawarehouse:writeMoves a purchase order to another status: DRAFT to SENT, SENT to CONFIRMED (or back), any status before RECEIVED to CANCELLED; any other move is refused.updateSupplierBetawarehouse:writeChanges a supplier: a field left out keeps its value, null clears an optional field.withdrawFoilBetawarehouse:writeIssues foil from stock (production, waste, a correction, a return to the supplier): books a movement and lowers the stock by the rolls the sheets take (sheets…withdrawPaintBetawarehouse:writeIssues paint from stock (production, waste, a correction, a return to the supplier): books a movement and lowers the stock by the grams taken.withdrawPaperBetawarehouse:writeIssues paper from stock (production, waste, a correction, a return to the supplier): books a movement and lowers the stock by the sheets taken.
Typy obiektowe
AdditionalCostAn additional cost charged on an order or one of its products, for example design work or express handling.BillingEntitiesResultOne page of billing entities and the size of the whole list.BillingEntityA company of the print shop that invoices its orders (a billing entity): the seller's data on its invoices.ClientA client of the print shop — a company, a sole proprietorship or an individual — with its contact persons, addresses, CRM notes and tags.ClientAddressAn address of a client: its headquarters, a delivery address, a warehouse, a billing address.ClientContactA contact person of a client — someone who orders or receives goods — from the client's address book (not a user of Prynt).ClientNoteA CRM note about a client: a call, a meeting, an e-mail or a plain note, by a member of the staff or an integration.ClientsResultPaginated list of clients.ClientTagA tag the print shop marks clients with, for example `VIP` or `Hurt`.CurrencyA currency the print shop sells in.CurrentApiKeyThe API key a request was made with: whose it is, what it may do now and until when.CurrentApiKeyIntegrationThe integration an API key belongs to: the account Prynt shows as the author of its changes.DieCutA die-cut (cutting die) kept in the warehouse: a tool, counted by uses, not by stock.DieCutsResultOne page of die-cuts and the size of the whole list.ElementAn element of a product: a part made separately, for example the cover or the inside pages of a book, with the operations that make it.ElementSpecTechnology of an element of an order, copied from the calculation it was priced with: sheet formats, ups, colours, plates and sheets.FileA file stored in Prynt and attached to a record, for example a print file of a product.FoilA foil kept in the warehouse in rolls (for laminating or stamping), cut into sheets when issued.FoilsResultOne page of foils and the size of the whole list.InitiateUploadResultWhere and how to send the file content: a single HTTP request to `uploadUrl`, then `completeFileUpload`.MachineA machine of the print shop (a press, a cutter, a laminator…): where operations and tasks run.MachinesResultOne page of machines and the size of the whole list.MatricesResultOne page of matrices and the size of the whole list.MatrixA matrix (embossing or stamping die) kept in the warehouse: a tool, counted by uses, not by stock.OperationA production operation on an element, for example printing or laminating, done on one machine.OperationCommentA note for production on an operation, as a label and a value (for example `Papier`: `Kreda 130 g`).OperationsResultOne page of operations and the size of the whole list.OrderA client's order at the print shop: the products to make, for whom, when and how to deliver them, and how the order is paid.OrderContactThe person to contact about an order, as saved on the order (a copy: later changes in the client's records do not change it).OrderDeliveryA delivery address of an order, with the packages and pallets that go there.OrderInvoiceBilling details of an order: who the invoice is made out to.OrderPaymentA payment received for an order, as recorded in Prynt.OrdersResultOne page of orders and the size of the whole list.PageInfoPosition of a page within a paginated list.PaintA paint (ink) kept in the warehouse, with its stock in grams.PaintsResultOne page of paints and the size of the whole list.PaperA paper (or other substrate) kept in the warehouse, with its stock in sheets.PapersResultOne page of papers and the size of the whole list.ProductA product of an order: one item the print shop makes (for example a book or leaflets), with its print run, price and production status.ProductInvoiceA sales invoice the print shop issued for a product of an order, as recorded in Prynt (the invoice itself is issued in the accounting system).ProductInvoicesResultOne page of product invoices and the size of the whole list.ProductionProgressHow far production of an element, a product or an order has got: the roll-up of all its operations.PurchaseInvoiceA purchase invoice: an invoice a supplier issued to the print shop, recorded in the warehouse.PurchaseInvoicesResultOne page of purchase invoices and the size of the whole list.PurchaseOrderAn order of materials from a supplier.PurchaseOrderItemAn item of a purchase order.PurchaseOrdersResultOne page of purchase orders and the size of the whole list.ReferenceDataItemAn entry of a dictionary of the print shop, for example an operation type or a color profile.StockMovementOne change of a material stock: a receipt, an issue, a correction or a stock-take adjustment.StockMovementsResultOne page of stock movements and the size of the whole list.StockTakeA stock take: counting what the warehouse holds.StockTakesResultOne page of stock takes and the size of the whole list.SupplierA supplier of warehouse materials.SupplierMaterialAn entry of a supplier's price list: a material and the price the supplier asks for it.SuppliersResultOne page of suppliers and the size of the whole list.TaskA production task: the shop floor working on one operation of an order, from start to completion.TasksResultOne page of tasks and the size of the whole list.VatRateA VAT rate the print shop uses: what `Product.taxRate` and `ProductInvoice.vatRate` hold.
Typy wejściowe
AddAdditionalCostInputA new additional cost, charged on an order or on one of its products.BillingEntityFilterInputConditions on billing entities: an entity is listed when it meets every condition given.BillingEntitySortInputHow to sort billing entities.ClientAddressInputA new address of a client: type, name, city, street, zip and country are required.ClientContactInputA contact person of a client.ClientFilterInputConditions on clients: a client is listed when it meets every condition given.ClientSortInputHow to sort clients.CompleteUploadInputThe file whose upload to complete.CreateClientInputA new client: a company, a sole proprietorship or an individual.CreateClientNoteInputA new CRM note about a client.CreateOrderInputA new order.CreateOrderPaymentInputA payment received for an order.CreateProductInputA product to add to an existing order.CreatePurchaseOrderInputA purchase order to a supplier, created as DRAFT.CreatePurchaseOrderItemInputAn item of a new purchase order.CreateSupplierInputA new supplier of warehouse materials.DieCutFilterInputConditions on die-cuts: a die-cut is listed when it meets every condition given.DieCutSortInputHow to sort die-cuts.FoilFilterInputConditions on foils: a foil is listed when it meets every condition given.FoilSortInputHow to sort foils.InitiateUploadInputA file to upload: its name, type and exact size, and the record to attach it to.MachineFilterInputConditions on machines: a machine is listed when it meets every condition given.MachineSortInputHow to sort machines.MatrixFilterInputConditions on matrices: a matrix is listed when it meets every condition given.MatrixSortInputHow to sort matrices.OperationFilterInputConditions on operations: an operation is listed when it meets every condition given.OperationSortInputHow to sort operations.OrderAdditionalCostInputAn additional cost of a new order, for example design work.OrderContactInputThe person to contact about an order.OrderDeliveryInputA delivery address of an order, with the packages and pallets that go there.OrderFilterInputConditions on orders: an order is listed when it meets every condition given.OrderInvoiceInputBilling details of an order: who the invoice is made out to.OrderProductElementInputAn element of a new product, for example the cover or the inside pages, with the operations that make it.OrderProductInputA product of a new order: what to make, how many, for what price, and its elements.OrderProductOperationInputA production operation of a new element, done on one machine.OrderSortInputHow to sort a list of orders.PaginationInputWhich page of a list to return.PaintFilterInputConditions on paints: a paint is listed when it meets every condition given.PaintSortInputHow to sort paints.PaperFilterInputConditions on papers: a paper is listed when it meets every condition given.PaperSortInputHow to sort papers.ProductInvoiceFilterInputConditions on product invoices: an invoice is listed when it meets every condition given.ProductInvoiceSortInputHow to sort product invoices.PurchaseInvoiceFilterInputConditions on purchase invoices: an invoice is listed when it meets every condition given.PurchaseInvoiceSortInputHow to sort purchase invoices.PurchaseOrderFilterInputConditions on purchase orders: an order is listed when it meets every condition given.PurchaseOrderSortInputHow to sort purchase orders.ReceiveFoilInputA receipt of foil into stock, e.g. a delivery booked outside purchase orders.ReceivePaintInputA receipt of paint into stock, e.g. a delivery booked outside purchase orders.ReceivePaperInputA receipt of paper into stock, e.g. a delivery booked outside purchase orders.ReceivePurchaseOrderInputA delivery received against a purchase order.ReceivePurchaseOrderItemInputHow much of one item arrived.StockMovementFilterInputConditions on stock movements: a movement is listed when it meets every condition given.StockMovementSortInputHow to sort stock movements.StockTakeFilterInputConditions on stock takes: a stock take is listed when it meets every condition given.StockTakeSortInputHow to sort stock takes.SupplierFilterInputConditions on suppliers: a supplier is listed when it meets every condition given.SupplierSortInputHow to sort suppliers.TaskFilterInputConditions on tasks: a task is listed when it meets every condition given.TaskSortInputHow to sort tasks.UpdateAdditionalCostInputChanges to an additional cost: fields left out keep their values.UpdateClientAddressInputWhat to change in an address: a field left out keeps its value; null clears an optional field and is refused for type, name, city, street, zip and country.UpdateClientInputWhat to change in a client: a field left out keeps its value, null clears a field that may be empty.UpdateClientNoteInputWhat to change in a note: a field left out keeps its value; null is refused.UpdateOperationInputWhat to change on an operation: fields left out keep their values.UpdateOrderInputChanges to an order: fields left out keep their values.UpdateProductInputChanges to a product: fields left out keep their values.UpdatePurchaseOrderInputA change of a purchase order: a field left out keeps its value.UpdatePurchaseOrderItemInputAn item in the full item list of a purchase-order change.UpdatePurchaseOrderStatusInputA purchase order and the status to move it to.UpdateSupplierInputA change of a supplier: a field left out keeps its value; null clears an optional field.WithdrawFoilInputAn issue of foil from stock: the sheets cut from the roll, what for and why.WithdrawPaintInputAn issue of paint from stock: the grams taken, what for and why.WithdrawPaperInputAn issue of paper from stock: the sheets taken, what for and why.
Enumy
AdditionalCostCategoryKind of an additional cost.BillingEntitySortFieldWhat to sort billing entities by.ClientBlockModeWhether the print shop takes and releases orders of a client — usually for unpaid invoices.ClientNoteTypeWhat a CRM note records.ClientSortFieldWhat to sort clients by.ClientTypeKind of client.DeliveryMethodHow a client's orders are delivered by default (the order's `TransportMethod` follows it).DieCutSortFieldWhat to sort die-cuts by.FileEntityTypeKind of record a file is attached to.FileUploadStatusWhere the upload of a file stands.FileVerificationStatusPrepress verdict on a print file of a product.FoilCategoryWhat a foil is used for.FoilSortFieldWhat to sort foils by.FoilTypeFinish of a foil.MachineSortFieldWhat to sort machines by.MaterialTypeKind of material a supplier delivers.MatrixMaterialWhat a matrix is made of.MatrixSortFieldWhat to sort matrices by.MatrixTypeWhat a matrix is for.OperationSortFieldWhat to sort operations by.OrderContactSourceWhere the contact person of an order was copied from.OrderSortFieldWhat to sort orders by.OrderSourceChannel an order came in through.OrderStatusStage of an order.PaintSortFieldWhat to sort paints by.PaperSortFieldWhat to sort papers by.PaperTypeThe kind of a paper (substrate) in the warehouse.PaperUnitThe unit the print shop buys and counts a paper in.PaymentMethodHow a client pays for an order.PaymentStatusWhere payment of an order stands.PrintSchemeHow a sheet is printed.ProductInvoiceSortFieldWhat to sort product invoices by.ProductInvoiceTypeType of an invoice of a product.ProductionStatusWhere production stands: of one operation (`Operation.productionStatus`), or of all operations of an element, a product or an order (`ProductionProgress.status…ProductStatusStage of a product: its print files, then production.PurchaseInvoiceSortFieldWhat to sort purchase invoices by.PurchaseOrderSortFieldWhat to sort purchase orders by.PurchaseOrderStatusWhere a purchase order is: from a draft to the last delivery.ReferenceDataTypeWhich dictionary of the print shop to read.SheetFormatKindWhat a sheet format is used as.SortDirectionDirection of a sorted list.StockMaterialTypeA kind of material the warehouse keeps stock of.StockMovementSortFieldWhat to sort stock movements by.StockMovementTypeWhat moved the stock.StockTakeDiscrepancyReasonWhy the stock counted in a stock take differs from the recorded stock.StockTakeScopeWhat a stock take counts.StockTakeSortFieldWhat to sort stock takes by.StockTakeStatusWhere a stock take is.StockUnitThe unit a material stock and its movements are counted in.SupplierSortFieldWhat to sort suppliers by.TaskSortFieldWhat to sort tasks by.TaskStatusWhere a production task stands: planned (PENDING, ASSIGNED), running (IN_PROGRESS), interrupted (PAUSED) or finished (COMPLETED, CANCELLED).TransportMethodHow an order reaches the client.UnitUnit of a quantity.WithdrawalTypeWhy material leaves the warehouse stock in an issue.
Skalary
DateTimeA date-time string at UTC, such as 2019-12-03T09:54:33Z, compliant with the date-time format.