{ "openapi": "3.0.0", "info": { "title": "Cin7 API", "version": "1.0.0", "description": "Based on simple REST principles, our API endpoints return data in JSON format for products, pricing, stock information, orders, payments and contacts.\r\nYou will need to have access to a Cin7 Omni account to set up your API connection and start using the API.\r\nCin7 Omni API uses \"Basic Authentication\" over HTTPS.\r\n The service will check the credentials on each request and return the response accordingly,\r\n in case of invalid credentials, the service responds with 401 error code i.e. unauthorized.\r\n" }, "paths": { "/api/v2/BomMasters/{id}": { "get": { "operationId": "GET-BomMastersV2-id", "summary": "Get a Bom Master.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Products": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "ModifiedBy": { "type": "integer", "description": "Modified by User ID." }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 } } }, "example": { "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] } ], "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "modifiedBy": 4, "productionNotes": "sample string 5", "reference": "sample string 6" } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "BomMastersV2" ], "security": [ { "basicAuth": [] } ] } }, "/api/v2/BomMasters": { "get": { "operationId": "GET-BomMastersV2-fields_where_order_page_rows", "summary": "Get a Bom Master.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Products": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "ModifiedBy": { "type": "integer", "description": "Modified by User ID." }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 } } } }, "example": [ { "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] } ], "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "modifiedBy": 4, "productionNotes": "sample string 5", "reference": "sample string 6" }, { "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "qty": 13.0, "unitCost": 14.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "qty": 14.0, "unitCost": 15.0 } ] } ], "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "modifiedBy": 4, "productionNotes": "sample string 5", "reference": "sample string 6" } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "BomMastersV2" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/PaymentFeesAndPayouts/Fees": { "get": { "operationId": "GET-FeesAndPayouts-fields_where_order_page_rows", "summary": "Get a list of payment fees.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "InvoiceReference": { "type": "string", "description": "Payment fee or payout reference, e.g. for fees we use \"PMTFEE-{id}\" and for payouts we use the Orders_25" }, "Description": { "type": "string", "description": "Description" }, "StripePaymentId": { "type": "string", "description": "Payment Id from stripe" }, "TransactionType": { "type": "string", "description": "Indicates whether the record is a Payment Fee or Payout." }, "CreatedDate": { "type": "string", "description": "Created Date in UTC, serialized as ISO 8601 (e.g. 2024-01-15T13:45:30Z).", "format": "date-time" }, "Total": { "type": "number", "description": "Amount of the fee or payout" }, "Currency": { "type": "string", "description": "Currency code (e.g. NZD, USD)" }, "AccountingTreatment": { "type": "string", "description": "Predefined DR/CR accounting behavior" }, "TaxTreatment": { "type": "string", "description": "Tax handling" }, "IsNetOfSettlement": { "type": "boolean", "description": "Indicates whether the amount is net of settlement" } } } }, "example": [ { "id": 1, "invoiceReference": "sample string 2", "description": "sample string 3", "stripePaymentId": "sample string 4", "transactionType": "sample string 5", "createdDate": "2026-04-20T05:47:08Z", "total": 6.0, "currency": "sample string 7", "accountingTreatment": "sample string 8", "taxTreatment": "sample string 9", "isNetOfSettlement": true }, { "id": 1, "invoiceReference": "sample string 2", "description": "sample string 3", "stripePaymentId": "sample string 4", "transactionType": "sample string 5", "createdDate": "2026-04-20T05:47:08Z", "total": 6.0, "currency": "sample string 7", "accountingTreatment": "sample string 8", "taxTreatment": "sample string 9", "isNetOfSettlement": true } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated list of fields to include in the response. Defaults to all fields if not specified.", "required": false, "schema": { "type": "string", "description": "Comma-separated list of fields to include in the response. Defaults to all fields if not specified." } }, { "name": "where", "in": "query", "description": "A where clause to filter specific records. Supports operators like AND and OR", "required": false, "schema": { "type": "string", "description": "A where clause to filter specific records. Supports operators like AND and OR" } }, { "name": "order", "in": "query", "description": "An order by clause to sort result by fields like CreatedDate DESC", "required": false, "schema": { "type": "string", "description": "An order by clause to sort result by fields like CreatedDate DESC" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "FeesAndPayouts" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/PaymentFeesAndPayouts/Payouts": { "get": { "operationId": "GET-FeesAndPayouts-fields_where_order_page_rows", "summary": "Get a list of payouts.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "InvoiceReference": { "type": "string", "description": "Payment fee or payout reference, e.g. for fees we use \"PMTFEE-{id}\" and for payouts we use the Orders_25" }, "Description": { "type": "string", "description": "Description" }, "StripePaymentId": { "type": "string", "description": "Payment Id from stripe" }, "TransactionType": { "type": "string", "description": "Indicates whether the record is a Payment Fee or Payout." }, "CreatedDate": { "type": "string", "description": "Created Date in UTC, serialized as ISO 8601 (e.g. 2024-01-15T13:45:30Z).", "format": "date-time" }, "Total": { "type": "number", "description": "Amount of the fee or payout" }, "Currency": { "type": "string", "description": "Currency code (e.g. NZD, USD)" }, "AccountingTreatment": { "type": "string", "description": "Predefined DR/CR accounting behavior" }, "TaxTreatment": { "type": "string", "description": "Tax handling" }, "IsNetOfSettlement": { "type": "boolean", "description": "Indicates whether the amount is net of settlement" } } } }, "example": [ { "id": 1, "invoiceReference": "sample string 2", "description": "sample string 3", "stripePaymentId": "sample string 4", "transactionType": "sample string 5", "createdDate": "2026-04-20T05:47:08Z", "total": 6.0, "currency": "sample string 7", "accountingTreatment": "sample string 8", "taxTreatment": "sample string 9", "isNetOfSettlement": true }, { "id": 1, "invoiceReference": "sample string 2", "description": "sample string 3", "stripePaymentId": "sample string 4", "transactionType": "sample string 5", "createdDate": "2026-04-20T05:47:08Z", "total": 6.0, "currency": "sample string 7", "accountingTreatment": "sample string 8", "taxTreatment": "sample string 9", "isNetOfSettlement": true } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "Comma-separated list of fields to include in the response. Defaults to all fields if not specified.", "required": false, "schema": { "type": "string", "description": "Comma-separated list of fields to include in the response. Defaults to all fields if not specified." } }, { "name": "where", "in": "query", "description": "A where clause to filter specific records. Supports operators like AND and OR", "required": false, "schema": { "type": "string", "description": "A where clause to filter specific records. Supports operators like AND and OR" } }, { "name": "order", "in": "query", "description": "An order by clause to sort result by fields like CreatedDate DESC", "required": false, "schema": { "type": "string", "description": "An order by clause to sort result by fields like CreatedDate DESC" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "FeesAndPayouts" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/ProductOptions/{id}": { "get": { "operationId": "GET-ProductOptions-id", "summary": "Get a Product Option.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Product Option Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modifie Date UTC", "format": "date-time" }, "Status": { "type": "string", "description": "Product Option Status: Primary, Active or Disabled", "enum": [ "Disabled", "Primary", "Active" ] }, "ProductId": { "type": "integer", "description": "The unique Cin7 product id" }, "Code": { "type": "string", "description": "[OBSOLETE] Use ProductOptionCode", "maximum": 20 }, "Barcode": { "type": "string", "description": "[OBSOLETE] Use ProductOptionBarcode", "maximum": 13 }, "ProductOptionCode": { "type": "string", "description": "The Product Option Code/SKU", "maximum": 20 }, "ProductOptionSizeCode": { "type": "string", "description": "The Product Option Size Code/SKU", "maximum": 20 }, "ProductOptionBarcode": { "type": "string", "description": "The Product Option Barcode", "maximum": 13 }, "ProductOptionSizeBarcode": { "type": "string", "description": "The Product Option Size Barcode", "maximum": 13 }, "SupplierCode": { "type": "string", "description": "Supplier code", "maximum": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Red)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "OptionWeight": { "type": "number", "description": "Product Option Weight" }, "Size": { "type": "string", "description": "Size" }, "SizeId": { "type": "integer", "description": "Size Id" }, "RetailPrice": { "type": "number", "description": "Retail Price", "format": "currency" }, "WholesalePrice": { "type": "number", "description": "Wholesale Price", "format": "currency" }, "VIPPrice": { "type": "number", "description": "VIP Price", "format": "currency" }, "SpecialPrice": { "type": "number", "description": "Special Price", "format": "currency" }, "SpecialsStartDate": { "type": "string", "description": "Specials Start Date", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "Number of days Specials last" }, "StockAvailable": { "type": "number", "description": "Stock Available" }, "StockOnHand": { "type": "number", "description": "Stock On Hand" }, "UomOptions": { "type": "array", "description": "UOM options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 UOM Option Id" }, "ProductOptionId": { "type": "integer", "description": "The unique Cin7 Product Option Id" }, "Code": { "type": "string", "description": "The UOM option code" }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)" }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)" }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)" }, "Quantity": { "type": "number", "description": "UOM quantity" }, "Barcode": { "type": "string", "description": "The UOM option barcode" }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code" }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Image": { "type": "object", "description": "A product option image", "properties": { "Link": { "type": "string", "description": "A link to an image" } } }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Primary", "productId": 1, "code": "SKU-RED-T", "barcode": "1234567890123", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Red", "option2": "XXL", "option3": "Yes", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": 59.0, "specialsStartDate": "2026-04-18T15:23:23Z", "specialDays": 7, "stockAvailable": 4.0, "stockOnHand": 2.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-red.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Active", "productId": 1, "code": "SKU-BLUE-T", "barcode": "BARCODE-FOR-BLUE-T", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Blue", "option2": "M", "option3": "Plain", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": null, "specialsStartDate": null, "specialDays": null, "stockAvailable": 10.0, "stockOnHand": 5.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-blue.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "ProductOptions" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/ProductOptions": { "get": { "operationId": "GET-ProductOptions-fields_where_order_page_rows", "summary": "Get a Product Option.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Product Option Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modifie Date UTC", "format": "date-time" }, "Status": { "type": "string", "description": "Product Option Status: Primary, Active or Disabled", "enum": [ "Disabled", "Primary", "Active" ] }, "ProductId": { "type": "integer", "description": "The unique Cin7 product id" }, "Code": { "type": "string", "description": "[OBSOLETE] Use ProductOptionCode", "maximum": 20 }, "Barcode": { "type": "string", "description": "[OBSOLETE] Use ProductOptionBarcode", "maximum": 13 }, "ProductOptionCode": { "type": "string", "description": "The Product Option Code/SKU", "maximum": 20 }, "ProductOptionSizeCode": { "type": "string", "description": "The Product Option Size Code/SKU", "maximum": 20 }, "ProductOptionBarcode": { "type": "string", "description": "The Product Option Barcode", "maximum": 13 }, "ProductOptionSizeBarcode": { "type": "string", "description": "The Product Option Size Barcode", "maximum": 13 }, "SupplierCode": { "type": "string", "description": "Supplier code", "maximum": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Red)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "OptionWeight": { "type": "number", "description": "Product Option Weight" }, "Size": { "type": "string", "description": "Size" }, "SizeId": { "type": "integer", "description": "Size Id" }, "RetailPrice": { "type": "number", "description": "Retail Price", "format": "currency" }, "WholesalePrice": { "type": "number", "description": "Wholesale Price", "format": "currency" }, "VIPPrice": { "type": "number", "description": "VIP Price", "format": "currency" }, "SpecialPrice": { "type": "number", "description": "Special Price", "format": "currency" }, "SpecialsStartDate": { "type": "string", "description": "Specials Start Date", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "Number of days Specials last" }, "StockAvailable": { "type": "number", "description": "Stock Available" }, "StockOnHand": { "type": "number", "description": "Stock On Hand" }, "UomOptions": { "type": "array", "description": "UOM options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 UOM Option Id" }, "ProductOptionId": { "type": "integer", "description": "The unique Cin7 Product Option Id" }, "Code": { "type": "string", "description": "The UOM option code" }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)" }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)" }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)" }, "Quantity": { "type": "number", "description": "UOM quantity" }, "Barcode": { "type": "string", "description": "The UOM option barcode" }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code" }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Image": { "type": "object", "description": "A product option image", "properties": { "Link": { "type": "string", "description": "A link to an image" } } }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Primary", "productId": 1, "code": "SKU-RED-T", "barcode": "1234567890123", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Red", "option2": "XXL", "option3": "Yes", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": 59.0, "specialsStartDate": "2026-04-18T15:23:23Z", "specialDays": 7, "stockAvailable": 4.0, "stockOnHand": 2.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-red.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Active", "productId": 1, "code": "SKU-BLUE-T", "barcode": "BARCODE-FOR-BLUE-T", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Blue", "option2": "M", "option3": "Plain", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": null, "specialsStartDate": null, "specialDays": null, "stockAvailable": 10.0, "stockOnHand": 5.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-blue.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "ProductOptions" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-ProductOptions-", "summary": "Create a list of ProductOptions", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductOptions" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": null, "enum": [ "Disabled", "Primary", "Active" ] }, "ProductId": { "type": "integer", "description": "The id of the Product this product option belongs to.", "minimum": 1.0, "maximum": 2147483647.0 }, "ProductOptionCode": { "type": "string", "description": "A unique Code for this product option.", "maximum": 20 }, "ProductOptionBarcode": { "type": "string", "description": "A unique barcode", "maximum": 20 }, "SupplierCode": { "type": "string", "description": null, "maximum": 20 }, "Option1": { "type": "string", "description": null, "maximum": 50 }, "Option2": { "type": "string", "description": null, "maximum": 50 }, "Option3": { "type": "string", "description": null, "maximum": 50 }, "SpecialPrice": { "type": "number", "description": "The special price" }, "SpecialsStartDate": { "type": "string", "description": "Start date for the speical price to apply", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "How many days the special will run starting from the SpecialsStartDate" }, "OptionWeight": { "type": "number", "description": "The option weight" }, "UomOptions": { "type": "array", "description": "An array of unit of measures.", "items": { "type": "object", "properties": { "Code": { "type": "string", "description": "The UOM option code", "minLength": 3, "maxLength": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: Color)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "Quantity": { "type": "number", "description": "UOM quantity\r\n Required when creating a new UOM", "minimum": 1E-06, "maximum": 2147483647.0 }, "Barcode": { "type": "string", "description": "The UOM option barcode", "minLength": 3, "maxLength": 30 }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code", "maximum": 50 }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } }, "required": [ "Code", "Quantity" ] }, "maximum": 20 }, "PriceColumns": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Sizes": { "type": "array", "description": "Product option sizes. A size range id needs to be assigned to the product before creating\r\n sizes.", "items": { "type": "object", "properties": { "Size": { "type": "string", "description": "Size name. The size name must match one of the sizes in the Size Range assigned to the product. Required when creating a new size.", "maximum": 20, "minimum": 1 }, "SizeCode": { "type": "string", "description": "A unique size code", "maximum": 20, "minimum": 1 }, "SizeBarcode": { "type": "string", "description": "A unique size barcode", "maximum": 20, "minimum": 1 } }, "required": [ "Size", "SizeCode" ] }, "maximum": 20 } }, "required": [ "Status", "ProductId", "ProductOptionCode" ] } }, "example": [ { "status": "Disabled", "productId": 1, "productOptionCode": "sample string 2", "productOptionBarcode": "sample string 3", "supplierCode": "sample string 4", "option1": "sample string 5", "option2": "sample string 6", "option3": "sample string 7", "specialPrice": 8.0, "specialsStartDate": "2026-04-20T05:47:08Z", "specialDays": 9, "optionWeight": 10.0, "uomOptions": [ { "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 5.0, "barcode": "sample string 6", "supplierCode": "sample string 7", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } }, { "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 5.0, "barcode": "sample string 6", "supplierCode": "sample string 7", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } } ], "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 }, "sizes": [ { "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" }, { "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" } ] }, { "status": "Disabled", "productId": 1, "productOptionCode": "sample string 2", "productOptionBarcode": "sample string 3", "supplierCode": "sample string 4", "option1": "sample string 5", "option2": "sample string 6", "option3": "sample string 7", "specialPrice": 8.0, "specialsStartDate": "2026-04-20T05:47:08Z", "specialDays": 9, "optionWeight": 10.0, "uomOptions": [ { "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 5.0, "barcode": "sample string 6", "supplierCode": "sample string 7", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } }, { "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 5.0, "barcode": "sample string 6", "supplierCode": "sample string 7", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } } ], "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 }, "sizes": [ { "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" }, { "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" } ] } ] } } } }, "put": { "operationId": "PUT-ProductOptions-", "summary": "Update a list of ProductOptions", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductOptions" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "Product Option Id" }, "Status": { "type": "string", "description": null, "enum": [ "Disabled", "Primary", "Active" ] }, "ProductOptionCode": { "type": "string", "description": "ProductOptionCode", "minLength": 1, "maxLength": 20 }, "ProductOptionBarcode": { "type": "string", "description": null, "minLength": 1, "maxLength": 20 }, "SupplierCode": { "type": "string", "description": null, "minLength": 1, "maxLength": 20 }, "Option1": { "type": "string", "description": null, "maximum": 50 }, "Option2": { "type": "string", "description": null, "maximum": 50 }, "Option3": { "type": "string", "description": null, "maximum": 50 }, "SpecialPrice": { "type": "number", "description": "The special price" }, "SpecialsStartDate": { "type": "string", "description": "Start date for the speical price to apply", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "How many days the special will run starting from the SpecialsStartDate" }, "OptionWeight": { "type": "number", "description": "The option weight" }, "UomOptions": { "type": "array", "description": "An array of unit of measures.", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The UOM Id\r\n Leave empty to create a new UOM or include to update an existing UOM" }, "Code": { "type": "string", "description": "The UOM option code", "minLength": 3, "maxLength": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: Color)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "Quantity": { "type": "number", "description": "UOM quantity\r\n Required when creating a new UOM", "minimum": 1E-06, "maximum": 2147483647.0 }, "Barcode": { "type": "string", "description": "The UOM option barcode", "minLength": 3, "maxLength": 30 }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code", "maximum": 50 }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "maximum": 20 }, "PriceColumns": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Sizes": { "type": "array", "description": "Product option sizes. A size range id needs to be assigned to the product before creating\r\n sizes.", "items": { "type": "object", "properties": { "SizeId": { "type": "integer", "description": "Size Id. Leave empty to create a new size, or include to update an existing size." }, "Size": { "type": "string", "description": "Size name. The size name must match one of the sizes in the Size Range assigned to the product. Required when creating a new size.", "maximum": 20, "minimum": 1 }, "SizeCode": { "type": "string", "description": "A unique size code", "maximum": 20, "minimum": 1 }, "SizeBarcode": { "type": "string", "description": "A unique size barcode", "maximum": 20, "minimum": 1 } } }, "maximum": 20 } }, "required": [ "Id" ] } }, "example": [ { "id": 1, "status": "Disabled", "productOptionCode": "sample string 1", "productOptionBarcode": "sample string 2", "supplierCode": "sample string 3", "option1": "sample string 4", "option2": "sample string 5", "option3": "sample string 6", "specialPrice": 1.0, "specialsStartDate": "2026-04-20T05:47:08Z", "specialDays": 1, "optionWeight": 1.0, "uomOptions": [ { "id": 1, "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 1.0, "barcode": "sample string 5", "supplierCode": "sample string 6", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } }, { "id": 1, "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 1.0, "barcode": "sample string 5", "supplierCode": "sample string 6", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } } ], "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 }, "sizes": [ { "sizeId": 1, "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" }, { "sizeId": 1, "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" } ] }, { "id": 1, "status": "Disabled", "productOptionCode": "sample string 1", "productOptionBarcode": "sample string 2", "supplierCode": "sample string 3", "option1": "sample string 4", "option2": "sample string 5", "option3": "sample string 6", "specialPrice": 1.0, "specialsStartDate": "2026-04-20T05:47:08Z", "specialDays": 1, "optionWeight": 1.0, "uomOptions": [ { "id": 1, "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 1.0, "barcode": "sample string 5", "supplierCode": "sample string 6", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } }, { "id": 1, "code": "sample string 1", "option1": "sample string 2", "option2": "sample string 3", "option3": "sample string 4", "quantity": 1.0, "barcode": "sample string 5", "supplierCode": "sample string 6", "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 } } ], "priceColumns": { "sample string 1": 1.0, "sample string 2": 1.0 }, "sizes": [ { "sizeId": 1, "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" }, { "sizeId": 1, "size": "sample string 1", "sizeCode": "sample string 2", "sizeBarcode": "sample string 3" } ] } ] } } } } }, "/api/v1/PurchaseOrders/{id}": { "get": { "operationId": "GET-PurchaseOrders-id", "summary": "Get a Purchase Order.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "SupplierInvoiceReference": { "type": "string", "description": null }, "SupplierAcceptanceDate": { "type": "string", "description": null, "format": "date-time" }, "Port": { "type": "string", "description": "Port for Indent Order." }, "EstimatedArrivalDate": { "type": "string", "description": "Estimated time of arrival for Indent Order.", "format": "date-time" }, "FullyReceivedDate": { "type": "string", "description": null, "format": "date-time" }, "InvoiceDate": { "type": "string", "description": null, "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": null, "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": "2026-04-19T00:00:00Z", "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "supplierInvoiceReference": "SupplierInvoiceReference", "supplierAcceptanceDate": "2026-04-19T00:00:00Z", "port": null, "estimatedArrivalDate": null, "fullyReceivedDate": "2026-04-19T00:00:00Z", "invoiceDate": "2026-04-18T15:23:23Z", "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 1, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "TEST", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 5.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitPrice": 20.0, "discount": 10.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null } ], "logisticsCarrier": null, "logisticsStatus": null } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "PurchaseOrders" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/PurchaseOrders": { "get": { "operationId": "GET-PurchaseOrders-fields_where_order_page_rows", "summary": "Get a Purchase Order.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SupplierInvoiceReference": { "type": "string", "description": null }, "SupplierAcceptanceDate": { "type": "string", "description": null, "format": "date-time" }, "Port": { "type": "string", "description": "Port for Indent Order." }, "EstimatedArrivalDate": { "type": "string", "description": "Estimated time of arrival for Indent Order.", "format": "date-time" }, "FullyReceivedDate": { "type": "string", "description": null, "format": "date-time" }, "InvoiceDate": { "type": "string", "description": null, "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": null, "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": "2026-04-19T00:00:00Z", "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "supplierInvoiceReference": "SupplierInvoiceReference", "supplierAcceptanceDate": "2026-04-19T00:00:00Z", "port": null, "estimatedArrivalDate": null, "fullyReceivedDate": "2026-04-19T00:00:00Z", "invoiceDate": "2026-04-18T15:23:23Z", "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 1, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "TEST", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 5.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitPrice": 20.0, "discount": 10.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null } ], "logisticsCarrier": null, "logisticsStatus": null } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "PurchaseOrders" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-PurchaseOrders-loadboms", "summary": "Create a list of Purchase Orders.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "PurchaseOrders" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SupplierInvoiceReference": { "type": "string", "description": null }, "SupplierAcceptanceDate": { "type": "string", "description": null, "format": "date-time" }, "Port": { "type": "string", "description": "Port for Indent Order." }, "EstimatedArrivalDate": { "type": "string", "description": "Estimated time of arrival for Indent Order.", "format": "date-time" }, "FullyReceivedDate": { "type": "string", "description": null, "format": "date-time" }, "InvoiceDate": { "type": "string", "description": null, "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 17, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 18, "processedBy": 19, "isApproved": true, "reference": "sample string 21", "memberId": 22, "firstName": "sample string 23", "lastName": "sample string 24", "company": "sample string 25", "email": "sample string 26", "phone": "sample string 27", "mobile": "sample string 28", "fax": "sample string 29", "deliveryFirstName": "sample string 30", "deliveryLastName": "sample string 31", "deliveryCompany": "sample string 32", "deliveryAddress1": "sample string 33", "deliveryAddress2": "sample string 34", "deliveryCity": "sample string 35", "deliveryState": "sample string 36", "deliveryPostalCode": "sample string 37", "deliveryCountry": "sample string 38", "billingFirstName": "sample string 39", "billingLastName": "sample string 40", "billingCompany": "sample string 41", "billingAddress1": "sample string 42", "billingAddress2": "sample string 43", "billingCity": "sample string 44", "billingPostalCode": "sample string 45", "billingState": "sample string 46", "billingCountry": "sample string 47", "branchId": 48, "branchEmail": "sample string 49", "projectName": "sample string 50", "trackingCode": "sample string 51", "internalComments": "sample string 52", "productTotal": 53.0, "freightTotal": 1.0, "freightDescription": "sample string 54", "surcharge": 1.0, "surchargeDescription": "sample string 55", "discountTotal": 1.0, "discountDescription": "sample string 56", "total": 57.0, "currencyCode": "sample string 59", "currencyRate": 60.0, "currencySymbol": "sample string 61", "taxStatus": "Undefined", "taxRate": 62.0, "source": "sample string 63", "customFields": { "sample string 1": {}, "sample string 3": {} }, "isVoid": true, "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" }, "memberEmail": "sample string 6", "memberCostCenter": "sample string 7", "memberAlternativeTaxRate": "sample string 8", "costCenter": "sample string 9", "alternativeTaxRate": "sample string 10", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 11, "salesPersonEmail": "sample string 12", "paymentTerms": "sample string 13", "customerOrderNo": "sample string 14", "voucherCode": "sample string 15", "deliveryInstructions": "sample string 16", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 5", "supplierInvoiceReference": "sample string 1", "supplierAcceptanceDate": "2026-04-20T05:47:08Z", "port": "sample string 2", "estimatedArrivalDate": "2026-04-20T05:47:08Z", "fullyReceivedDate": "2026-04-20T05:47:08Z", "invoiceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" }, { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" } ], "logisticsCarrier": "sample string 3", "logisticsStatus": 1 }, { "id": 17, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 18, "processedBy": 19, "isApproved": true, "reference": "sample string 21", "memberId": 22, "firstName": "sample string 23", "lastName": "sample string 24", "company": "sample string 25", "email": "sample string 26", "phone": "sample string 27", "mobile": "sample string 28", "fax": "sample string 29", "deliveryFirstName": "sample string 30", "deliveryLastName": "sample string 31", "deliveryCompany": "sample string 32", "deliveryAddress1": "sample string 33", "deliveryAddress2": "sample string 34", "deliveryCity": "sample string 35", "deliveryState": "sample string 36", "deliveryPostalCode": "sample string 37", "deliveryCountry": "sample string 38", "billingFirstName": "sample string 39", "billingLastName": "sample string 40", "billingCompany": "sample string 41", "billingAddress1": "sample string 42", "billingAddress2": "sample string 43", "billingCity": "sample string 44", "billingPostalCode": "sample string 45", "billingState": "sample string 46", "billingCountry": "sample string 47", "branchId": 48, "branchEmail": "sample string 49", "projectName": "sample string 50", "trackingCode": "sample string 51", "internalComments": "sample string 52", "productTotal": 53.0, "freightTotal": 1.0, "freightDescription": "sample string 54", "surcharge": 1.0, "surchargeDescription": "sample string 55", "discountTotal": 1.0, "discountDescription": "sample string 56", "total": 57.0, "currencyCode": "sample string 59", "currencyRate": 60.0, "currencySymbol": "sample string 61", "taxStatus": "Undefined", "taxRate": 62.0, "source": "sample string 63", "customFields": { "sample string 1": {}, "sample string 3": {} }, "isVoid": true, "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" }, "memberEmail": "sample string 6", "memberCostCenter": "sample string 7", "memberAlternativeTaxRate": "sample string 8", "costCenter": "sample string 9", "alternativeTaxRate": "sample string 10", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 11, "salesPersonEmail": "sample string 12", "paymentTerms": "sample string 13", "customerOrderNo": "sample string 14", "voucherCode": "sample string 15", "deliveryInstructions": "sample string 16", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 5", "supplierInvoiceReference": "sample string 1", "supplierAcceptanceDate": "2026-04-20T05:47:08Z", "port": "sample string 2", "estimatedArrivalDate": "2026-04-20T05:47:08Z", "fullyReceivedDate": "2026-04-20T05:47:08Z", "invoiceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" }, { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" } ], "logisticsCarrier": "sample string 3", "logisticsStatus": 1 } ] } } } }, "put": { "operationId": "PUT-PurchaseOrders-loadboms", "summary": "Update a list of Purchase Orders.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "PurchaseOrders" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SupplierInvoiceReference": { "type": "string", "description": null }, "SupplierAcceptanceDate": { "type": "string", "description": null, "format": "date-time" }, "Port": { "type": "string", "description": "Port for Indent Order." }, "EstimatedArrivalDate": { "type": "string", "description": "Estimated time of arrival for Indent Order.", "format": "date-time" }, "FullyReceivedDate": { "type": "string", "description": null, "format": "date-time" }, "InvoiceDate": { "type": "string", "description": null, "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 17, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 18, "processedBy": 19, "isApproved": true, "reference": "sample string 21", "memberId": 22, "firstName": "sample string 23", "lastName": "sample string 24", "company": "sample string 25", "email": "sample string 26", "phone": "sample string 27", "mobile": "sample string 28", "fax": "sample string 29", "deliveryFirstName": "sample string 30", "deliveryLastName": "sample string 31", "deliveryCompany": "sample string 32", "deliveryAddress1": "sample string 33", "deliveryAddress2": "sample string 34", "deliveryCity": "sample string 35", "deliveryState": "sample string 36", "deliveryPostalCode": "sample string 37", "deliveryCountry": "sample string 38", "billingFirstName": "sample string 39", "billingLastName": "sample string 40", "billingCompany": "sample string 41", "billingAddress1": "sample string 42", "billingAddress2": "sample string 43", "billingCity": "sample string 44", "billingPostalCode": "sample string 45", "billingState": "sample string 46", "billingCountry": "sample string 47", "branchId": 48, "branchEmail": "sample string 49", "projectName": "sample string 50", "trackingCode": "sample string 51", "internalComments": "sample string 52", "productTotal": 53.0, "freightTotal": 1.0, "freightDescription": "sample string 54", "surcharge": 1.0, "surchargeDescription": "sample string 55", "discountTotal": 1.0, "discountDescription": "sample string 56", "total": 57.0, "currencyCode": "sample string 59", "currencyRate": 60.0, "currencySymbol": "sample string 61", "taxStatus": "Undefined", "taxRate": 62.0, "source": "sample string 63", "customFields": { "sample string 1": {}, "sample string 3": {} }, "isVoid": true, "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" }, "memberEmail": "sample string 6", "memberCostCenter": "sample string 7", "memberAlternativeTaxRate": "sample string 8", "costCenter": "sample string 9", "alternativeTaxRate": "sample string 10", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 11, "salesPersonEmail": "sample string 12", "paymentTerms": "sample string 13", "customerOrderNo": "sample string 14", "voucherCode": "sample string 15", "deliveryInstructions": "sample string 16", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 5", "supplierInvoiceReference": "sample string 1", "supplierAcceptanceDate": "2026-04-20T05:47:08Z", "port": "sample string 2", "estimatedArrivalDate": "2026-04-20T05:47:08Z", "fullyReceivedDate": "2026-04-20T05:47:08Z", "invoiceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" }, { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" } ], "logisticsCarrier": "sample string 3", "logisticsStatus": 1 }, { "id": 17, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 18, "processedBy": 19, "isApproved": true, "reference": "sample string 21", "memberId": 22, "firstName": "sample string 23", "lastName": "sample string 24", "company": "sample string 25", "email": "sample string 26", "phone": "sample string 27", "mobile": "sample string 28", "fax": "sample string 29", "deliveryFirstName": "sample string 30", "deliveryLastName": "sample string 31", "deliveryCompany": "sample string 32", "deliveryAddress1": "sample string 33", "deliveryAddress2": "sample string 34", "deliveryCity": "sample string 35", "deliveryState": "sample string 36", "deliveryPostalCode": "sample string 37", "deliveryCountry": "sample string 38", "billingFirstName": "sample string 39", "billingLastName": "sample string 40", "billingCompany": "sample string 41", "billingAddress1": "sample string 42", "billingAddress2": "sample string 43", "billingCity": "sample string 44", "billingPostalCode": "sample string 45", "billingState": "sample string 46", "billingCountry": "sample string 47", "branchId": 48, "branchEmail": "sample string 49", "projectName": "sample string 50", "trackingCode": "sample string 51", "internalComments": "sample string 52", "productTotal": 53.0, "freightTotal": 1.0, "freightDescription": "sample string 54", "surcharge": 1.0, "surchargeDescription": "sample string 55", "discountTotal": 1.0, "discountDescription": "sample string 56", "total": 57.0, "currencyCode": "sample string 59", "currencyRate": 60.0, "currencySymbol": "sample string 61", "taxStatus": "Undefined", "taxRate": 62.0, "source": "sample string 63", "customFields": { "sample string 1": {}, "sample string 3": {} }, "isVoid": true, "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" }, "memberEmail": "sample string 6", "memberCostCenter": "sample string 7", "memberAlternativeTaxRate": "sample string 8", "costCenter": "sample string 9", "alternativeTaxRate": "sample string 10", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 11, "salesPersonEmail": "sample string 12", "paymentTerms": "sample string 13", "customerOrderNo": "sample string 14", "voucherCode": "sample string 15", "deliveryInstructions": "sample string 16", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 5", "supplierInvoiceReference": "sample string 1", "supplierAcceptanceDate": "2026-04-20T05:47:08Z", "port": "sample string 2", "estimatedArrivalDate": "2026-04-20T05:47:08Z", "fullyReceivedDate": "2026-04-20T05:47:08Z", "invoiceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" }, { "id": 10, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 12, "parentId": 1, "productId": 13, "productOptionId": 14, "integrationRef": "sample string 15", "sort": 16, "code": "sample string 17", "name": "sample string 18", "option1": "sample string 19", "option2": "sample string 20", "option3": "sample string 21", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0, "accountCode": "sample string 9" } ], "logisticsCarrier": "sample string 3", "logisticsStatus": 1 } ] } } } } }, "/api/v1/Stock": { "get": { "operationId": "GET-Stock-fields_where_order_page_rows", "summary": "Get a Stock Unit.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "ProductId": { "type": "integer", "description": "The unique Cin7 product Id." }, "ProductOptionId": { "type": "integer", "description": "The Product Option Id" }, "ModifiedDate": { "type": "string", "description": "Last Transaction Date", "format": "date-time" }, "StyleCode": { "type": "string", "description": "The style code." }, "Code": { "type": "string", "description": "The unique code i.e. SKU" }, "Barcode": { "type": "string", "description": "Barcode i.e. UPC" }, "BranchId": { "type": "integer", "description": "The unique Cin7 branch Id." }, "BranchName": { "type": "string", "description": "The branch name." }, "ProductName": { "type": "string", "description": "The product name" }, "Option1": { "type": "string", "description": "Product option 1 (example: Red)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (example: XL)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (example: Cotton)", "maximum": 50 }, "Size": { "type": "string", "description": "Size (mainly for clothing when color size grid module is used)" }, "Available": { "type": "number", "description": "Available to Sell (StockOnHand - OpenSales)" }, "StockOnHand": { "type": "number", "description": "The stock on hand (SOH)" }, "OpenSales": { "type": "number", "description": "The open sales quantity i.e. The number of stock items on order." }, "Incoming": { "type": "number", "description": "Inbound purchase order quantity" }, "Virtual": { "type": "number", "description": "Virtual stock for Kit products, zero for non-kit products" }, "Holding": { "type": "number", "description": "Holding stock." } } } }, "example": [ { "productId": 1, "productOptionId": 0, "modifiedDate": "2026-04-19T03:23:23Z", "styleCode": "StyleCode123", "code": "ABC123", "barcode": "123456789012", "branchId": 1, "branchName": "Main Branch", "productName": "T-Shirt", "option1": "Red", "option2": null, "option3": null, "size": "XXL", "available": 2.0, "stockOnHand": 9.0, "openSales": 7.0, "incoming": 8.0, "virtual": 0.0, "holding": 0.0 } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Stock" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Contacts/{id}": { "get": { "operationId": "GET-Contacts-id", "summary": "Get a Contact.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Type": { "type": "string", "description": "Contact Type: Customer, Supplier", "enum": [ "Internal", "Customer", "Supplier" ] }, "SalesPersonId": { "type": "integer", "description": "The User Id" }, "AccountNumber": { "type": "string", "description": "Account Number", "maximum": 10 }, "BillingId": { "type": "integer", "description": "Parent company member id" }, "BillingCompany": { "type": "string", "description": "Billing Company", "maximum": 50 }, "AccountsFirstName": { "type": "string", "description": "Accounts contact first name", "maximum": 50 }, "AccountsLastName": { "type": "string", "description": "Accounts contact last name", "maximum": 50 }, "BillingEmail": { "type": "string", "description": "Billing Email", "maximum": 50 }, "AccountsPhone": { "type": "string", "description": "Accounts contact phone", "maximum": 50 }, "BillingCostCenter": { "type": "string", "description": "Alternative GL account of a Parent company if exists" }, "CostCenter": { "type": "string", "description": "Alternative GL account" }, "PriceColumn": { "type": "string", "description": "A price column name. Query ProductOptions to get a list of valid price column names." }, "PercentageOff": { "type": "number", "description": "Percentage Off Price Tier. Price discount on top of PriceColumn.", "minimum": 0.0, "maximum": 100.0 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "TaxNumber": { "type": "string", "description": "Taxt Number" }, "CreditLimit": { "type": "number", "description": "Credit Limit" }, "BalanceOwing": { "type": "number", "description": "Balance Owing" }, "OnHold": { "type": "boolean", "description": "Hold Status" }, "Group": { "type": "string", "description": "Group" }, "SubGroup": { "type": "string", "description": "Subgroup" }, "Stages": { "type": "string", "description": "Stages" }, "AccountingIntegrationId": { "type": "object", "description": "Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly)", "properties": { "Xero": { "type": "string", "description": null }, "QuickBooksOnline": { "type": "string", "description": null }, "QuickBooksDesktop": { "type": "string", "description": null } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } }, "required": [ "Type" ] }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Acme Corporation", "firstName": "Jane", "lastName": "Doe", "jobTitle": "Managing Director", "email": "jane@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": "Bob's Company", "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null }, { "id": 2, "company": null, "firstName": "Lara", "lastName": "Croft", "jobTitle": "Accountant", "email": "lara@acmecorpation.com", "mobile": null, "phone": null } ], "type": "Customer", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company Name", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Contacts" ], "security": [ { "basicAuth": [] } ] }, "delete": { "operationId": "DELETE-Contacts-id", "summary": "Delete a Contact.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Contacts" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Contacts": { "get": { "operationId": "GET-Contacts-fields_where_order_page_rows", "summary": "Get a Contact.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "Contact Type: Customer, Supplier", "enum": [ "Internal", "Customer", "Supplier" ] }, "SalesPersonId": { "type": "integer", "description": "The User Id" }, "AccountNumber": { "type": "string", "description": "Account Number", "maximum": 10 }, "BillingId": { "type": "integer", "description": "Parent company member id" }, "BillingCompany": { "type": "string", "description": "Billing Company", "maximum": 50 }, "AccountsFirstName": { "type": "string", "description": "Accounts contact first name", "maximum": 50 }, "AccountsLastName": { "type": "string", "description": "Accounts contact last name", "maximum": 50 }, "BillingEmail": { "type": "string", "description": "Billing Email", "maximum": 50 }, "AccountsPhone": { "type": "string", "description": "Accounts contact phone", "maximum": 50 }, "BillingCostCenter": { "type": "string", "description": "Alternative GL account of a Parent company if exists" }, "CostCenter": { "type": "string", "description": "Alternative GL account" }, "PriceColumn": { "type": "string", "description": "A price column name. Query ProductOptions to get a list of valid price column names." }, "PercentageOff": { "type": "number", "description": "Percentage Off Price Tier. Price discount on top of PriceColumn.", "minimum": 0.0, "maximum": 100.0 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "TaxNumber": { "type": "string", "description": "Taxt Number" }, "CreditLimit": { "type": "number", "description": "Credit Limit" }, "BalanceOwing": { "type": "number", "description": "Balance Owing" }, "OnHold": { "type": "boolean", "description": "Hold Status" }, "Group": { "type": "string", "description": "Group" }, "SubGroup": { "type": "string", "description": "Subgroup" }, "Stages": { "type": "string", "description": "Stages" }, "AccountingIntegrationId": { "type": "object", "description": "Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly)", "properties": { "Xero": { "type": "string", "description": null }, "QuickBooksOnline": { "type": "string", "description": null }, "QuickBooksDesktop": { "type": "string", "description": null } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } }, "required": [ "Type" ] } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Acme Corporation", "firstName": "Jane", "lastName": "Doe", "jobTitle": "Managing Director", "email": "jane@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": "Bob's Company", "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null }, { "id": 2, "company": null, "firstName": "Lara", "lastName": "Croft", "jobTitle": "Accountant", "email": "lara@acmecorpation.com", "mobile": null, "phone": null } ], "type": "Customer", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company Name", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } }, { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Supplier Company", "firstName": "Jack", "lastName": "", "jobTitle": "Owner", "email": "jack@suppliercompany.com", "website": "www.suppliercompany.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "Address1", "address2": "Address2", "city": "City", "state": "State", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "USA", "notes": "Sample supplier contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": null, "type": "Supplier", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "Filter by an any element", "required": false, "schema": { "type": "string", "description": "Filter by an any element" } }, { "name": "order", "in": "query", "description": "Order by any element returned", "required": false, "schema": { "type": "string", "description": "Order by any element returned" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Contacts" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Contacts-", "summary": "Create a list of Contacts.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Contacts" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "Contact Type: Customer, Supplier", "enum": [ "Internal", "Customer", "Supplier" ] }, "SalesPersonId": { "type": "integer", "description": "The User Id" }, "AccountNumber": { "type": "string", "description": "Account Number", "maximum": 10 }, "BillingId": { "type": "integer", "description": "Parent company member id" }, "BillingCompany": { "type": "string", "description": "Billing Company", "maximum": 50 }, "AccountsFirstName": { "type": "string", "description": "Accounts contact first name", "maximum": 50 }, "AccountsLastName": { "type": "string", "description": "Accounts contact last name", "maximum": 50 }, "BillingEmail": { "type": "string", "description": "Billing Email", "maximum": 50 }, "AccountsPhone": { "type": "string", "description": "Accounts contact phone", "maximum": 50 }, "BillingCostCenter": { "type": "string", "description": "Alternative GL account of a Parent company if exists" }, "CostCenter": { "type": "string", "description": "Alternative GL account" }, "PriceColumn": { "type": "string", "description": "A price column name. Query ProductOptions to get a list of valid price column names." }, "PercentageOff": { "type": "number", "description": "Percentage Off Price Tier. Price discount on top of PriceColumn.", "minimum": 0.0, "maximum": 100.0 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "TaxNumber": { "type": "string", "description": "Taxt Number" }, "CreditLimit": { "type": "number", "description": "Credit Limit" }, "BalanceOwing": { "type": "number", "description": "Balance Owing" }, "OnHold": { "type": "boolean", "description": "Hold Status" }, "Group": { "type": "string", "description": "Group" }, "SubGroup": { "type": "string", "description": "Subgroup" }, "Stages": { "type": "string", "description": "Stages" }, "AccountingIntegrationId": { "type": "object", "description": "Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly)", "properties": { "Xero": { "type": "string", "description": null }, "QuickBooksOnline": { "type": "string", "description": null }, "QuickBooksDesktop": { "type": "string", "description": null } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } }, "required": [ "Type" ] } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Acme Corporation", "firstName": "Jane", "lastName": "Doe", "jobTitle": "Managing Director", "email": "jane@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": "Bob's Company", "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null }, { "id": 2, "company": null, "firstName": "Lara", "lastName": "Croft", "jobTitle": "Accountant", "email": "lara@acmecorpation.com", "mobile": null, "phone": null } ], "type": "Customer", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company Name", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } }, { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Supplier Company", "firstName": "Jack", "lastName": "", "jobTitle": "Owner", "email": "jack@suppliercompany.com", "website": "www.suppliercompany.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "Address1", "address2": "Address2", "city": "City", "state": "State", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "USA", "notes": "Sample supplier contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": null, "type": "Supplier", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } } ] } } } }, "put": { "operationId": "PUT-Contacts-", "summary": "Update a list of Contacts.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Contacts" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Type": { "type": "string", "description": "Contact Type: Customer, Supplier", "enum": [ "Internal", "Customer", "Supplier" ] }, "SalesPersonId": { "type": "integer", "description": "The User Id" }, "AccountNumber": { "type": "string", "description": "Account Number", "maximum": 10 }, "BillingId": { "type": "integer", "description": "Parent company member id" }, "BillingCompany": { "type": "string", "description": "Billing Company", "maximum": 50 }, "AccountsFirstName": { "type": "string", "description": "Accounts contact first name", "maximum": 50 }, "AccountsLastName": { "type": "string", "description": "Accounts contact last name", "maximum": 50 }, "BillingEmail": { "type": "string", "description": "Billing Email", "maximum": 50 }, "AccountsPhone": { "type": "string", "description": "Accounts contact phone", "maximum": 50 }, "BillingCostCenter": { "type": "string", "description": "Alternative GL account of a Parent company if exists" }, "CostCenter": { "type": "string", "description": "Alternative GL account" }, "PriceColumn": { "type": "string", "description": "A price column name. Query ProductOptions to get a list of valid price column names." }, "PercentageOff": { "type": "number", "description": "Percentage Off Price Tier. Price discount on top of PriceColumn.", "minimum": 0.0, "maximum": 100.0 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "TaxNumber": { "type": "string", "description": "Taxt Number" }, "CreditLimit": { "type": "number", "description": "Credit Limit" }, "BalanceOwing": { "type": "number", "description": "Balance Owing" }, "OnHold": { "type": "boolean", "description": "Hold Status" }, "Group": { "type": "string", "description": "Group" }, "SubGroup": { "type": "string", "description": "Subgroup" }, "Stages": { "type": "string", "description": "Stages" }, "AccountingIntegrationId": { "type": "object", "description": "Accounting Integration Ids for Xero, QuickBooks Online and QuickBooks Desktop (readonly)", "properties": { "Xero": { "type": "string", "description": null }, "QuickBooksOnline": { "type": "string", "description": null }, "QuickBooksDesktop": { "type": "string", "description": null } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } }, "required": [ "Type" ] } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Acme Corporation", "firstName": "Jane", "lastName": "Doe", "jobTitle": "Managing Director", "email": "jane@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": "Bob's Company", "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null }, { "id": 2, "company": null, "firstName": "Lara", "lastName": "Croft", "jobTitle": "Accountant", "email": "lara@acmecorpation.com", "mobile": null, "phone": null } ], "type": "Customer", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company Name", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } }, { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Supplier Company", "firstName": "Jack", "lastName": "", "jobTitle": "Owner", "email": "jack@suppliercompany.com", "website": "www.suppliercompany.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "Address1", "address2": "Address2", "city": "City", "state": "State", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "USA", "notes": "Sample supplier contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": null, "type": "Supplier", "salesPersonId": 0, "accountNumber": null, "billingId": 0, "billingCompany": "Billing Company", "accountsFirstName": "Account Contact First Name", "accountsLastName": "Account Contact Last Name", "billingEmail": "", "accountsPhone": "(000) 123-4567", "billingCostCenter": null, "costCenter": null, "priceColumn": "Retail", "percentageOff": null, "paymentTerms": null, "taxStatus": null, "taxNumber": null, "creditLimit": 0.0, "balanceOwing": null, "onHold": null, "group": null, "subGroup": null, "stages": null, "accountingIntegrationId": { "xero": "12345", "quickBooksOnline": "12345", "quickBooksDesktop": null } } ] } } } } }, "/api/v1/ProductionJobs/{id}": { "get": { "operationId": "GET-ProductionJobs-id", "summary": "Get a Production Job.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "CompletedBy": { "type": "integer", "description": "Completed by User ID." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "BranchId": { "type": "integer", "description": "Branch ID" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 }, "Source": { "type": "string", "description": "The source" }, "TotalCost": { "type": "number", "description": "Product Total" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Products": { "type": "array", "description": "Production Job Products.", "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components (Read-only)", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } } } }, "example": { "id": 99, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "dueDate": "2026-04-25T15:23:23Z", "completedDate": "2026-04-18T15:23:23Z", "createdBy": 10, "completedBy": 10, "isApproved": false, "branchId": 1, "company": null, "projectName": "Test Project", "productionNotes": "Test Job", "reference": "JOB-1", "source": "API", "totalCost": 100.0, "customFields": null, "products": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Make", "sort": 0, "code": "TestProduct1", "name": "Composite Product", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 100.0, "components": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C1", "name": "Component 1", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 50.0 }, { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C2", "name": "Component 2", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 50.0 } ] } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "ProductionJobs" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/ProductionJobs": { "get": { "operationId": "GET-ProductionJobs-fields_where_order_page_rows", "summary": "Get a Production Job.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "CompletedBy": { "type": "integer", "description": "Completed by User ID." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "BranchId": { "type": "integer", "description": "Branch ID" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 }, "Source": { "type": "string", "description": "The source" }, "TotalCost": { "type": "number", "description": "Product Total" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Products": { "type": "array", "description": "Production Job Products.", "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components (Read-only)", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } } } } }, "example": [ { "id": 99, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "dueDate": "2026-04-25T15:23:23Z", "completedDate": "2026-04-18T15:23:23Z", "createdBy": 10, "completedBy": 10, "isApproved": false, "branchId": 1, "company": null, "projectName": "Test Project", "productionNotes": "Test Job", "reference": "JOB-1", "source": "API", "totalCost": 100.0, "customFields": null, "products": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Make", "sort": 0, "code": "TestProduct1", "name": "Composite Product", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 100.0, "components": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C1", "name": "Component 1", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 50.0 }, { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C2", "name": "Component 2", "option1": null, "option2": null, "option3": null, "notes": null, "dueDate": null, "standardQty": 1.0, "actualQty": 1.0, "unitCost": 50.0 } ] } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "ProductionJobs" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-ProductionJobs-", "summary": "Create a list of Production Jobs.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductionJobs" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "CompletedBy": { "type": "integer", "description": "Completed by User ID." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "BranchId": { "type": "integer", "description": "Branch ID" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 }, "Source": { "type": "string", "description": "The source" }, "TotalCost": { "type": "number", "description": "Product Total" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Products": { "type": "array", "description": "Production Job Products.", "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components (Read-only)", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "dueDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "createdBy": 2, "completedBy": 3, "isApproved": true, "branchId": 5, "company": "sample string 6", "projectName": "sample string 7", "productionNotes": "sample string 8", "reference": "sample string 9", "source": "sample string 10", "totalCost": 11.0, "customFields": { "sample string 1": {}, "sample string 3": {} }, "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "dueDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "createdBy": 2, "completedBy": 3, "isApproved": true, "branchId": 5, "company": "sample string 6", "projectName": "sample string 7", "productionNotes": "sample string 8", "reference": "sample string 9", "source": "sample string 10", "totalCost": 11.0, "customFields": { "sample string 1": {}, "sample string 3": {} }, "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] } ] } ] } } } }, "put": { "operationId": "PUT-ProductionJobs-", "summary": "Update a list of Production Jobs.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductionJobs" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "CompletedBy": { "type": "integer", "description": "Completed by User ID." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "BranchId": { "type": "integer", "description": "Branch ID" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 }, "Source": { "type": "string", "description": "The source" }, "TotalCost": { "type": "number", "description": "Product Total" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Products": { "type": "array", "description": "Production Job Products.", "items": { "type": "object", "properties": { "Components": { "type": "array", "description": "Product Components (Read-only)", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "DueDate": { "type": "string", "description": "Due Date", "format": "date-time" }, "StandardQty": { "type": "number", "description": "Standard Qty" }, "ActualQty": { "type": "number", "description": "Actual quantity (Read-only)" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "StandardQty" ] } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "dueDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "createdBy": 2, "completedBy": 3, "isApproved": true, "branchId": 5, "company": "sample string 6", "projectName": "sample string 7", "productionNotes": "sample string 8", "reference": "sample string 9", "source": "sample string 10", "totalCost": 11.0, "customFields": { "sample string 1": {}, "sample string 3": {} }, "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "dueDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "createdBy": 2, "completedBy": 3, "isApproved": true, "branchId": 5, "company": "sample string 6", "projectName": "sample string 7", "productionNotes": "sample string 8", "reference": "sample string 9", "source": "sample string 10", "totalCost": 11.0, "customFields": { "sample string 1": {}, "sample string 3": {} }, "products": [ { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] }, { "id": 1, "productId": 4, "productOptionId": 5, "type": "Undefined", "sort": 6, "code": "sample string 7", "name": "sample string 8", "option1": "sample string 9", "option2": "sample string 10", "option3": "sample string 11", "notes": "sample string 12", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 13.0, "actualQty": 14.0, "unitCost": 1.0, "components": [ { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 }, { "id": 2, "productId": 5, "productOptionId": 6, "type": "Undefined", "sort": 7, "code": "sample string 8", "name": "sample string 9", "option1": "sample string 10", "option2": "sample string 11", "option3": "sample string 12", "notes": "sample string 13", "dueDate": "2026-04-20T05:47:08Z", "standardQty": 14.0, "actualQty": 15.0, "unitCost": 1.0 } ] } ] } ] } } } } }, "/api/v1/ProductCategories/{id}": { "get": { "operationId": "GET-ProductCategories-id", "summary": "Get a Product Category", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": null }, "ParentId": { "type": "integer", "description": null }, "IsActive": { "type": "boolean", "description": null }, "Sort": { "type": "integer", "description": null }, "Name": { "type": "string", "description": null }, "Description": { "type": "string", "description": null }, "Image": { "type": "object", "description": null, "properties": { "Link": { "type": "string", "description": "A link to an image" } } } } }, "example": { "id": 1, "parentId": 0, "isActive": true, "sort": 0, "name": "Apparel", "description": null, "image": null } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "ProductCategories" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/ProductCategories": { "get": { "operationId": "GET-ProductCategories-fields_where_order_page_rows", "summary": "Get a Product Category", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": null }, "ParentId": { "type": "integer", "description": null }, "IsActive": { "type": "boolean", "description": null }, "Sort": { "type": "integer", "description": null }, "Name": { "type": "string", "description": null }, "Description": { "type": "string", "description": null }, "Image": { "type": "object", "description": null, "properties": { "Link": { "type": "string", "description": "A link to an image" } } } } } }, "example": [ { "id": 1, "parentId": 0, "isActive": true, "sort": 0, "name": "Apparel", "description": null, "image": null }, { "id": 2, "parentId": 1, "isActive": true, "sort": 0, "name": "Shirts", "description": null, "image": null } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "ProductCategories" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-ProductCategories-", "summary": "Creates new Product Categories.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductCategories" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": null, "maximum": 50 }, "Description": { "type": "string", "description": null, "maximum": 250 }, "ParentId": { "type": "integer", "description": "Parent category Id. 0 for top level.\r\n Default is 0.", "minimum": 0.0, "maximum": 2147483647.0 }, "Sort": { "type": "integer", "description": null, "minimum": 0.0, "maximum": 2147483647.0 } }, "required": [ "Name" ] } }, "example": [ { "name": "sample string 1", "description": "sample string 2", "parentId": 3, "sort": 4 }, { "name": "sample string 1", "description": "sample string 2", "parentId": 3, "sort": 4 } ] } } } }, "put": { "operationId": "PUT-ProductCategories-", "summary": "Updates Product Categories.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "ProductCategories" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": null, "minimum": 1.0, "maximum": 2147483647.0 }, "Name": { "type": "string", "description": null, "maximum": 50 }, "Description": { "type": "string", "description": null, "maximum": 250 }, "ParentId": { "type": "integer", "description": "Category Id of the parent category.\r\n 0 for root category (or to unlink from parent).\r\n null to not update.", "minimum": 0.0, "maximum": 2147483647.0 }, "Sort": { "type": "integer", "description": null, "minimum": 0.0, "maximum": 2147483647.0 } } } }, "example": [ { "id": 1, "name": "sample string 2", "description": "sample string 3", "parentId": 1, "sort": 1 }, { "id": 1, "name": "sample string 2", "description": "sample string 3", "parentId": 1, "sort": 1 } ] } } } } }, "/api/v1/SalesOrders/{id}": { "get": { "operationId": "GET-SalesOrders-id", "summary": "Get a Sales Order.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "id": 128, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "SALE4-28", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "invoiceDate": "2026-04-18T15:23:23Z", "invoiceNumber": 0, "dispatchedDate": "2026-04-18T15:23:23Z", "logisticsCarrier": null, "logisticsStatus": null, "ediStatus": null, "distributionBranchId": null, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "uomPrice": null, "discount": 0.0, "uomQtyOrdered": null, "uomQtyShipped": 0.0, "uomSize": null, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 2, "productOptionId": 3, "integrationRef": "LineItem2", "sort": 2, "code": "", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": 12.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 83.33, "uomPrice": 1000.0, "discount": 10.0, "uomQtyOrdered": 1.0, "uomQtyShipped": 0.0, "uomSize": 12.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "SalesOrders" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/SalesOrders": { "get": { "operationId": "GET-SalesOrders-fields_where_order_page_rows", "summary": "Get a Sales Order.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 128, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "SALE4-28", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "invoiceDate": "2026-04-18T15:23:23Z", "invoiceNumber": 0, "dispatchedDate": "2026-04-18T15:23:23Z", "logisticsCarrier": null, "logisticsStatus": null, "ediStatus": null, "distributionBranchId": null, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "uomPrice": null, "discount": 0.0, "uomQtyOrdered": null, "uomQtyShipped": 0.0, "uomSize": null, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 2, "productOptionId": 3, "integrationRef": "LineItem2", "sort": 2, "code": "", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": 12.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 83.33, "uomPrice": 1000.0, "discount": 10.0, "uomQtyOrdered": 1.0, "uomQtyShipped": 0.0, "uomSize": 12.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "SalesOrders" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-SalesOrders-loadboms", "summary": "Create a list of Sales Orders.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "SalesOrders" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "createdDate": "2024-01-25T01:02:00Z", "modifiedDate": "2024-01-25T01:04:52Z", "createdBy": 1, "processedBy": 2, "isApproved": true, "reference": "SALE4-281", "memberId": 3, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Alex", "deliveryLastName": "Smith", "deliveryCompany": "Alex's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": null, "billingLastName": null, "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 3, "branchEmail": "branch@acompany.com", "projectName": "", "trackingCode": "", "internalComments": "", "productTotal": 1096.0, "freightTotal": 10.0, "freightDescription": "FEDEX", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 5.0, "discountDescription": "Christmas Sale", "total": 1101.0, "currencyCode": "NZD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Exempt", "taxRate": 0.0, "customFields": { "orders_1000": null, "orders_1001": "" }, "isVoid": false, "accountingAttributes": { "importDate": null, "accountingImportStatus": "NotImported" }, "memberEmail": "alex@acompany.com", "memberCostCenter": "Online Sales", "memberAlternativeTaxRate": "No GST", "costCenter": "Online Sales", "alternativeTaxRate": "No GST", "estimatedDeliveryDate": "2024-01-26T01:04:00Z", "salesPersonId": 29956, "salesPersonEmail": null, "paymentTerms": "7 Days from invoice", "customerOrderNo": "", "voucherCode": null, "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "APPROVED", "stage": "Dispatched", "invoiceDate": "2024-01-26T01:04:00Z", "invoiceNumber": 5149, "dispatchedDate": "2024-01-26T01:04:00Z", "logisticsCarrier": "", "logisticsStatus": 0, "ediStatus": 0, "distributionBranchId": 0, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "lineItems": [ { "createdDate": "2024-01-25T01:04:58Z", "productOptionId": 2, "integrationRef": "0", "sort": 10, "code": "Size-XL", "name": "Size Product", "option1": "XL", "option2": "", "option3": "1 x 10", "qty": 1.0, "styleCode": "SizeProduct", "barcode": "", "lineComments": "", "unitCost": 0.0, "unitPrice": 100.0, "uomPrice": null, "discount": 2.0, "uomQtyOrdered": null, "accountCode": "", "stockControl": "Batch" }, { "createdDate": "2024-01-25T01:04:58Z", "productOptionId": 3, "integrationRef": "0", "sort": 10, "code": "TBC-12", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": null, "styleCode": "", "barcode": "", "lineComments": "", "unitCost": 0.0, "unitPrice": null, "uomPrice": 1000, "discount": 2.0, "uomQtyOrdered": 1.0, "accountCode": "", "stockControl": "FIFO" } ] } ] } } } }, "put": { "operationId": "PUT-SalesOrders-loadboms", "summary": "Update a list of Sales Orders.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "SalesOrders" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 703, "createdDate": "2024-01-25T01:02:00Z", "modifiedDate": "2024-01-25T01:04:52Z", "createdBy": 1, "processedBy": 2, "isApproved": true, "reference": "SALE4-281", "memberId": 3, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Alex", "deliveryLastName": "Smith", "deliveryCompany": "Alex's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": null, "billingLastName": null, "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 3, "branchEmail": "branch@acompany.com", "projectName": "", "trackingCode": "", "internalComments": "", "productTotal": 1096.0, "freightTotal": 10.0, "freightDescription": "FEDEX", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 5.0, "discountDescription": "Christmas Sale", "total": 1101.0, "currencyCode": "NZD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Exempt", "taxRate": 0.0, "customFields": { "orders_1000": null, "orders_1001": "" }, "isVoid": false, "accountingAttributes": { "importDate": null, "accountingImportStatus": "NotImported" }, "memberEmail": "alex@acompany.com", "memberCostCenter": "Online Sales", "memberAlternativeTaxRate": "No GST", "costCenter": "Online Sales", "alternativeTaxRate": "No GST", "estimatedDeliveryDate": "2024-01-26T01:04:00Z", "salesPersonId": 29956, "salesPersonEmail": null, "paymentTerms": "7 Days from invoice", "customerOrderNo": "", "voucherCode": null, "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "APPROVED", "stage": "Dispatched", "invoiceDate": "2024-01-26T01:04:00Z", "invoiceNumber": 5149, "dispatchedDate": "2024-01-26T01:04:00Z", "logisticsCarrier": "", "logisticsStatus": 0, "ediStatus": 0, "distributionBranchId": 0, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "lineItems": [ { "id": 1901, "createdDate": "2024-01-25T01:04:58Z", "transactionId": 703, "productOptionId": 2, "integrationRef": "0", "sort": 10, "code": "Size-XL", "name": "Size Product", "option1": "XL", "option2": "", "option3": "1 x 10", "qty": 1.0, "styleCode": "SizeProduct", "barcode": "", "lineComments": "", "unitCost": 0.0, "unitPrice": 100.0, "uomPrice": null, "discount": 2.0, "uomQtyOrdered": null, "accountCode": "", "stockControl": "Batch" }, { "id": 1902, "createdDate": "2024-01-25T01:04:58Z", "transactionId": 703, "productOptionId": 3, "integrationRef": "0", "sort": 10, "code": "TBC-12", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": null, "styleCode": "", "barcode": "", "lineComments": "", "unitCost": 0.0, "unitPrice": null, "uomPrice": 1000, "discount": 2.0, "uomQtyOrdered": 1.0, "accountCode": "", "stockControl": "FIFO" } ] } ] } } } } }, "/api/v1/Users/{id}": { "get": { "operationId": "GET-Users-id", "summary": "Get a User.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The user ID." }, "IsActive": { "type": "boolean", "description": "The status of the User" }, "FirstName": { "type": "string", "description": "The user first name." }, "LastName": { "type": "string", "description": "The user last name." }, "JobTitle": { "type": "string", "description": "The user job title." }, "Email": { "type": "string", "description": "The user email." } } }, "example": { "id": 1000, "isActive": true, "firstName": "Jane", "lastName": "Doe", "jobTitle": "Director", "email": "jane@domain.com" } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Users" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Users": { "get": { "operationId": "GET-Users-", "summary": "Get a User.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The user ID." }, "IsActive": { "type": "boolean", "description": "The status of the User" }, "FirstName": { "type": "string", "description": "The user first name." }, "LastName": { "type": "string", "description": "The user last name." }, "JobTitle": { "type": "string", "description": "The user job title." }, "Email": { "type": "string", "description": "The user email." } } } }, "example": [ { "id": 1000, "isActive": true, "firstName": "Jane", "lastName": "Doe", "jobTitle": "Director", "email": "jane@domain.com" } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Users" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/ProductImages": { "post": { "operationId": "POST-ProductImages-productId_imagePriority", "summary": "", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "productId", "in": "query", "description": "", "required": true, "schema": { "type": "integer", "description": "" } }, { "name": "imagePriority", "in": "query", "description": "", "required": true, "schema": { "type": "string", "description": "", "format": "enum", "enum": [ "Primary", "Secondary", "Tertiary" ] } } ], "tags": [ "ProductImages" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "file": { "type": "string", "format": "binary" } } }, "example": {} } } } } }, "/api/v1/SalesOrdersWithCartons/{id}": { "get": { "operationId": "GET-SalesOrdersWithCartons-id", "summary": "Get a Sales Order with it's Carton details.", "description": "", "responses": { "200": { "description": "Single Order JSON Object", "content": { "application/json": { "schema": { "type": "object", "properties": { "SSCCNumber": { "type": "string", "description": "The Serial Shipping Container Code (SSCC Number) at the order level." }, "CartonsWithLineItems": { "type": "array", "description": "The cartons for this order.", "items": { "type": "object", "properties": { "Number": { "type": "string", "description": null }, "SSCC": { "type": "string", "description": null }, "Length": { "type": "number", "description": null }, "Depth": { "type": "number", "description": null }, "Height": { "type": "number", "description": null }, "Volume": { "type": "number", "description": null }, "Weight": { "type": "number", "description": null }, "TrackingNumber": { "type": "string", "description": null }, "PalletNumber": { "type": "string", "description": null }, "CartonItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "LineItemId": { "type": "integer", "description": null }, "ProductCode": { "type": "string", "description": null }, "BatchNumber": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null } } } } } } }, "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "id": 128, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "SALE4-28", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "invoiceDate": "2026-04-18T15:23:23Z", "invoiceNumber": 0, "dispatchedDate": "2026-04-18T15:23:23Z", "logisticsCarrier": null, "logisticsStatus": null, "ediStatus": null, "distributionBranchId": null, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "ssccNumber": "SSCCNumber", "cartonsWithLineItems": [ { "number": "Number", "sscc": "SSCC", "length": 1.0, "depth": 1.0, "height": 1.0, "volume": 1.0, "weight": 1.0, "trackingNumber": "TrackingNumber", "palletNumber": "PalletNumber", "cartonItems": [ { "lineItemId": 1, "productCode": "Code1", "batchNumber": "BatchNumber", "quantity": 2.0 }, { "lineItemId": 2, "productCode": "Code2", "batchNumber": "BatchNumber", "quantity": 12.0 } ] } ], "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "Code1", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "uomPrice": null, "discount": 0.0, "uomQtyOrdered": null, "uomQtyShipped": 0.0, "uomSize": null, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 2, "productOptionId": 3, "integrationRef": "LineItem2", "sort": 2, "code": "Code2", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": 12.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 83.33, "uomPrice": 1000.0, "discount": 10.0, "uomQtyOrdered": 1.0, "uomQtyShipped": 0.0, "uomSize": 12.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "Order Id", "required": true, "schema": { "type": "integer", "description": "Order Id" } } ], "tags": [ "SalesOrdersWithCartons" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/SalesOrdersWithCartons": { "get": { "operationId": "GET-SalesOrdersWithCartons-fields_where_order_page_rows", "summary": "Get a Sales Order with it's Carton details.", "description": "", "responses": { "200": { "description": "Single Order JSON Object", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SSCCNumber": { "type": "string", "description": "The Serial Shipping Container Code (SSCC Number) at the order level." }, "CartonsWithLineItems": { "type": "array", "description": "The cartons for this order.", "items": { "type": "object", "properties": { "Number": { "type": "string", "description": null }, "SSCC": { "type": "string", "description": null }, "Length": { "type": "number", "description": null }, "Depth": { "type": "number", "description": null }, "Height": { "type": "number", "description": null }, "Volume": { "type": "number", "description": null }, "Weight": { "type": "number", "description": null }, "TrackingNumber": { "type": "string", "description": null }, "PalletNumber": { "type": "string", "description": null }, "CartonItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "LineItemId": { "type": "integer", "description": null }, "ProductCode": { "type": "string", "description": null }, "BatchNumber": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null } } } } } } }, "InvoiceDate": { "type": "string", "description": "Invoice date", "format": "date-time" }, "InvoiceNumber": { "type": "integer", "description": "Invoice number. This is a read-only field. It is updated when an invoice date is provided." }, "DispatchedDate": { "type": "string", "description": "The date that the order was fully dispatched.", "format": "date-time" }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "EdiStatus": { "type": "integer", "description": "Edi Status" }, "DistributionBranchId": { "type": "integer", "description": "Distribution Branch" }, "DepartmentNumber": { "type": "string", "description": "Department Number" }, "StoreLocationNumber": { "type": "string", "description": "Store Location Number" }, "DistributionCenter": { "type": "string", "description": "Distribution Center" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barcode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "UomPrice": { "type": "number", "description": "Uom Price of the product. To create/update UOM's use UomPrice instead of UnitPrice." }, "Discount": { "type": "number", "description": "Total line item discount" }, "UomQtyOrdered": { "type": "number", "description": "Uom Qty Ordered. To create/update UOM's use UomQtyOrdered instead of Qty." }, "UomQtyShipped": { "type": "number", "description": "​Uom Qty shipped/dispatched. This field is read-only. This is calculated from QtyShipped. ​" }, "UomSize": { "type": "number", "description": "Uom Size. (Read-only)" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (Read-only)." }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code. Omit to default to Product GL." }, "StockControl": { "type": "string", "description": null, "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "StockMovements": { "type": "array", "description": "Dispatch quantities. (Read-only)", "items": { "type": "object", "properties": { "Batch": { "type": "string", "description": null }, "Quantity": { "type": "number", "description": null }, "Serial": { "type": "string", "description": null } } } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "IsVoid": { "type": "boolean", "description": "Set to true to void an order; note this behaviour is irreversible." }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Integration", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 128, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "SALE4-28", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "isVoid": false, "accountingAttributes": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "invoiceDate": "2026-04-18T15:23:23Z", "invoiceNumber": 0, "dispatchedDate": "2026-04-18T15:23:23Z", "logisticsCarrier": null, "logisticsStatus": null, "ediStatus": null, "distributionBranchId": null, "departmentNumber": null, "storeLocationNumber": null, "distributionCenter": null, "ssccNumber": "SSCCNumber", "cartonsWithLineItems": [ { "number": "Number", "sscc": "SSCC", "length": 1.0, "depth": 1.0, "height": 1.0, "volume": 1.0, "weight": 1.0, "trackingNumber": "TrackingNumber", "palletNumber": "PalletNumber", "cartonItems": [ { "lineItemId": 1, "productCode": "Code1", "batchNumber": "BatchNumber", "quantity": 2.0 }, { "lineItemId": 2, "productCode": "Code2", "batchNumber": "BatchNumber", "quantity": 12.0 } ] } ], "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "Code1", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "uomPrice": null, "discount": 0.0, "uomQtyOrdered": null, "uomQtyShipped": 0.0, "uomSize": null, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 2, "productOptionId": 3, "integrationRef": "LineItem2", "sort": 2, "code": "Code2", "name": "Product with UOM", "option1": "Box", "option2": "", "option3": "", "qty": 12.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 83.33, "uomPrice": 1000.0, "discount": 10.0, "uomQtyOrdered": 1.0, "uomQtyShipped": 0.0, "uomSize": 12.0, "qtyShipped": 0.0, "holdingQty": 0.0, "accountCode": null, "stockControl": "Undefined", "stockMovements": null, "sizes": null, "taxRate": null } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "SalesOrdersWithCartons" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Voucher": { "get": { "operationId": "GET-Voucher-fields_where_order_page_rows", "summary": "Get a Voucher.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "CreatedDate": { "type": "string", "description": "Voucher Created Date", "format": "date-time" }, "Status": { "type": "string", "description": "Status - Active: voucher has balance, Inactive: already fully redeemed" }, "Code": { "type": "string", "description": "Voucher Code" }, "Type": { "type": "string", "description": "Voucher Type" }, "Description": { "type": "string", "description": "Promotion Description" }, "ExpiryDate": { "type": "string", "description": "Voucher Expiry Date", "format": "date-time" }, "Amount": { "type": "number", "description": "Voucher Amount" }, "CustomerID": { "type": "integer", "description": "Customer ID of which voucher is assigned to" }, "CustomerEmail": { "type": "string", "description": "Customer Email of which voucher is assigned to" }, "RedeemedCount": { "type": "integer", "description": "Count on how many times the voucher has been redeemed. Only makes sense when RedeemedCountLimit=1" }, "RedeemedCountLimit": { "type": "integer", "description": "Limit on how many times the voucher can be fully redeemed, should always be 1 unless modified from backend.\r\n Cin7 vouchers don't have limit counts on partial redemptions as long as they have balance left." }, "RedeemedAmount": { "type": "number", "description": "Voucher Redeemed Amount" } } } }, "example": [ { "createdDate": "2026-04-20T05:47:08Z", "status": "sample string 2", "code": "sample string 3", "type": "sample string 4", "description": "sample string 5", "expiryDate": "2026-04-20T05:47:08Z", "amount": 7.0, "customerID": 8, "customerEmail": "sample string 9", "redeemedCount": 10, "redeemedCountLimit": 11, "redeemedAmount": 12.0 }, { "createdDate": "2026-04-20T05:47:08Z", "status": "sample string 2", "code": "sample string 3", "type": "sample string 4", "description": "sample string 5", "expiryDate": "2026-04-20T05:47:08Z", "amount": 7.0, "customerID": 8, "customerEmail": "sample string 9", "redeemedCount": 10, "redeemedCountLimit": 11, "redeemedAmount": 12.0 } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Voucher" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/BranchTransfers/{id}": { "get": { "operationId": "GET-BranchTransfers-id", "summary": "Get a Branch Transfer", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "ApprovedBy": { "type": "integer", "description": "The ID of the User who approved the Branch Transfer." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique reference.", "maximum": 20 }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, ​beware the dog.", "maximum": 2000 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total" }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "Source": { "type": "string", "description": "The source of the Transaction." }, "SourceBranchId": { "type": "integer", "description": "Source Branch ID" }, "DestinationBranchId": { "type": "integer", "description": "Destination Branch ID" }, "ApprovalDate": { "type": "string", "description": "Approval Date", "format": "date-time" }, "DispatchedDate": { "type": "string", "description": "Dispatched Date", "format": "date-time" }, "ReceivedDate": { "type": "string", "description": "Received Date", "format": "date-time" }, "Stage": { "type": "string", "description": "Stage" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "QtyTransferred": { "type": "integer", "description": "Quantity Transferred; this field is read-only, Branch Transfers must be dispatched and completed in Cin7." }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "Sizes": { "type": "array", "description": "Sizes; this field is read-only.", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": null }, "Code": { "type": "string", "description": null }, "Barcode": { "type": "string", "description": null }, "qty": { "type": "number", "description": null } } } }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } }, "example": { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "BranchTransfers" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/BranchTransfers": { "get": { "operationId": "GET-BranchTransfers-fields_where_order_page_rows", "summary": "Get a Branch Transfer", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "ApprovedBy": { "type": "integer", "description": "The ID of the User who approved the Branch Transfer." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique reference.", "maximum": 20 }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, ​beware the dog.", "maximum": 2000 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total" }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "Source": { "type": "string", "description": "The source of the Transaction." }, "SourceBranchId": { "type": "integer", "description": "Source Branch ID" }, "DestinationBranchId": { "type": "integer", "description": "Destination Branch ID" }, "ApprovalDate": { "type": "string", "description": "Approval Date", "format": "date-time" }, "DispatchedDate": { "type": "string", "description": "Dispatched Date", "format": "date-time" }, "ReceivedDate": { "type": "string", "description": "Received Date", "format": "date-time" }, "Stage": { "type": "string", "description": "Stage" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "QtyTransferred": { "type": "integer", "description": "Quantity Transferred; this field is read-only, Branch Transfers must be dispatched and completed in Cin7." }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "Sizes": { "type": "array", "description": "Sizes; this field is read-only.", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": null }, "Code": { "type": "string", "description": null }, "Barcode": { "type": "string", "description": null }, "qty": { "type": "number", "description": null } } } }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "BranchTransfers" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-BranchTransfers-", "summary": "Create a list of Branch Transfers.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "BranchTransfers" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "ApprovedBy": { "type": "integer", "description": "The ID of the User who approved the Branch Transfer." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique reference.", "maximum": 20 }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, ​beware the dog.", "maximum": 2000 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total" }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "Source": { "type": "string", "description": "The source of the Transaction." }, "SourceBranchId": { "type": "integer", "description": "Source Branch ID" }, "DestinationBranchId": { "type": "integer", "description": "Destination Branch ID" }, "ApprovalDate": { "type": "string", "description": "Approval Date", "format": "date-time" }, "DispatchedDate": { "type": "string", "description": "Dispatched Date", "format": "date-time" }, "ReceivedDate": { "type": "string", "description": "Received Date", "format": "date-time" }, "Stage": { "type": "string", "description": "Stage" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "QtyTransferred": { "type": "integer", "description": "Quantity Transferred; this field is read-only, Branch Transfers must be dispatched and completed in Cin7." }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "Sizes": { "type": "array", "description": "Sizes; this field is read-only.", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": null }, "Code": { "type": "string", "description": null }, "Barcode": { "type": "string", "description": null }, "qty": { "type": "number", "description": null } } } }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] } ] } } } }, "put": { "operationId": "PUT-BranchTransfers-", "summary": "Update a list of Branch Transfers.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "BranchTransfers" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "ApprovedBy": { "type": "integer", "description": "The ID of the User who approved the Branch Transfer." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique reference.", "maximum": 20 }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, ​beware the dog.", "maximum": 2000 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total" }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "Source": { "type": "string", "description": "The source of the Transaction." }, "SourceBranchId": { "type": "integer", "description": "Source Branch ID" }, "DestinationBranchId": { "type": "integer", "description": "Destination Branch ID" }, "ApprovalDate": { "type": "string", "description": "Approval Date", "format": "date-time" }, "DispatchedDate": { "type": "string", "description": "Dispatched Date", "format": "date-time" }, "ReceivedDate": { "type": "string", "description": "Received Date", "format": "date-time" }, "Stage": { "type": "string", "description": "Stage" }, "CustomFields": { "type": "array", "description": "Custom Fields", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "QtyTransferred": { "type": "integer", "description": "Quantity Transferred; this field is read-only, Branch Transfers must be dispatched and completed in Cin7." }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "Sizes": { "type": "array", "description": "Sizes; this field is read-only.", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": null }, "Code": { "type": "string", "description": null }, "Barcode": { "type": "string", "description": null }, "qty": { "type": "number", "description": null } } } }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 1, "processedBy": 1, "approvedBy": 1, "isApproved": true, "reference": "sample string 1", "branchEmail": "sample string 2", "deliveryInstructions": "sample string 3", "internalComments": "sample string 4", "productTotal": 1.0, "firstName": "sample string 5", "lastName": "sample string 6", "company": "sample string 7", "email": "sample string 8", "phone": "sample string 9", "mobile": "sample string 10", "fax": "sample string 11", "projectName": "sample string 12", "trackingCode": "sample string 13", "source": "sample string 14", "sourceBranchId": 1, "destinationBranchId": 1, "approvalDate": "2026-04-20T05:47:08Z", "dispatchedDate": "2026-04-20T05:47:08Z", "receivedDate": "2026-04-20T05:47:08Z", "stage": "sample string 15", "customFields": { "sample string 1": {}, "sample string 3": {} }, "lineItems": [ { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] }, { "createdDate": "2026-04-20T05:47:08Z", "transactionId": 5, "parentId": 1, "productId": 6, "productOptionId": 7, "integrationRef": "sample string 8", "sort": 9, "code": "sample string 10", "name": "sample string 11", "option1": "sample string 12", "option2": "sample string 13", "option3": "sample string 14", "qty": 1.0, "id": 1, "qtyTransferred": 1, "unitCost": 2.0, "sizes": [ { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 }, { "name": "sample string 1", "code": "sample string 2", "barcode": "sample string 3", "qty": 4.0 } ] } ] } ] } } } } }, "/api/v1/BomMasters/{id}": { "get": { "operationId": "GET-BomMasters-id", "summary": "Get a Bom Master.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Product": { "type": "object", "description": "Bom", "properties": { "Components": { "type": "array", "description": "Product Components", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] }, "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "ModifiedBy": { "type": "integer", "description": "Modified by User ID." }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 } } }, "example": { "product": { "id": 0, "productId": 0, "productOptionId": 0, "type": "Make", "sort": 0, "code": "TestProduct1", "name": "Composite Product", "option1": null, "option2": null, "option3": null, "notes": null, "qty": 1.0, "unitCost": 100.0, "components": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C1", "name": "Component 1", "option1": null, "option2": null, "option3": null, "notes": null, "qty": 1.0, "unitCost": 50.0 } ] }, "id": 99, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 10, "modifiedBy": 0, "productionNotes": "Test Job", "reference": null } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "BomMasters" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/BomMasters": { "get": { "operationId": "GET-BomMasters-fields_where_order_page_rows", "summary": "Get a Bom Master.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Product": { "type": "object", "description": "Bom", "properties": { "Components": { "type": "array", "description": "Product Components", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] } }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "ProductId": { "type": "integer", "description": "Product ID" }, "ProductOptionId": { "type": "integer", "description": "Product option ID" }, "Type": { "type": "string", "description": "Component Type (Make, Use, Addon).", "enum": [ "Undefined", "Make", "Use", "Addon" ] }, "Sort": { "type": "integer", "description": "Sort Order" }, "Code": { "type": "string", "description": "Item Code" }, "Name": { "type": "string", "description": "Item Name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Notes": { "type": "string", "description": "Notes" }, "Qty": { "type": "number", "description": "Standard Qty" }, "UnitCost": { "type": "number", "description": "Unit Cost" } }, "required": [ "Qty" ] }, "Id": { "type": "integer", "description": "A unique Job ID." }, "CreatedDate": { "type": "string", "description": "Created date time.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date time.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "Created by User ID." }, "ModifiedBy": { "type": "integer", "description": "Modified by User ID." }, "ProductionNotes": { "type": "string", "description": "Production Notes." }, "Reference": { "type": "string", "description": "The unique Job reference.", "maximum": 20 } } } }, "example": [ { "product": { "id": 0, "productId": 0, "productOptionId": 0, "type": "Make", "sort": 0, "code": "TestProduct1", "name": "Composite Product", "option1": null, "option2": null, "option3": null, "notes": null, "qty": 1.0, "unitCost": 100.0, "components": [ { "id": 0, "productId": 0, "productOptionId": 0, "type": "Use", "sort": 0, "code": "C1", "name": "Component 1", "option1": null, "option2": null, "option3": null, "notes": null, "qty": 1.0, "unitCost": 50.0 } ] }, "id": 99, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 10, "modifiedBy": 0, "productionNotes": "Test Job", "reference": null } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "BomMasters" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/SizeRanges/{id}": { "get": { "operationId": "GET-SizeRanges-id", "summary": "Get SizeRange", "description": "", "responses": { "200": { "description": "A list of JSON Objects", "content": { "application/json": { "schema": { "type": "object", "properties": { "SizeRangeName": { "type": "string", "description": null }, "Sizes": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Id": { "type": "integer", "description": null } } }, "example": {} } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "SizeRanges" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/SizeRanges": { "get": { "operationId": "GET-SizeRanges-", "summary": "Get SizeRange", "description": "", "responses": { "200": { "description": "A list of JSON Objects", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "SizeRangeName": { "type": "string", "description": null }, "Sizes": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "Id": { "type": "integer", "description": null } } } }, "example": [] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "SizeRanges" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Cartons/{id}": { "get": { "operationId": "GET-Cartons-id", "summary": "Get the Carton details for a Sales Order.", "description": "", "responses": { "200": { "description": "A list of JSON Objects", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Number": { "type": "string", "description": "Carton Number. Numbers only.", "maximum": 20 }, "SSCC": { "type": "string", "description": "SSCC Number. Numbers only.", "maximum": 20, "minimum": 18 }, "Length": { "type": "number", "description": "Length" }, "Depth": { "type": "number", "description": "Depth" }, "Height": { "type": "number", "description": "Height" }, "Volume": { "type": "number", "description": "Volume" }, "Weight": { "type": "number", "description": "Weight" }, "TrackingNumber": { "type": "string", "description": "Tracking Number", "maximum": 50 }, "CartonItems": { "type": "array", "description": "Carton Items", "items": { "type": "object", "properties": { "LineItemId": { "type": "integer", "description": "Cin7 Sales Order Line Item ID" }, "ProductCode": { "type": "string", "description": "Product Code/SKU. Used to match the LineItemId if none supplied.", "maximum": 50 }, "BatchNumber": { "type": "string", "description": "Batch Number", "maximum": 50 }, "Quantity": { "type": "number", "description": "Quantity" } }, "required": [ "ProductCode", "Quantity" ] } } }, "required": [ "SSCC", "CartonItems" ] } }, "example": [ { "number": "1", "sscc": "00094219040000473889", "length": 10.2, "depth": 10.2, "height": 20.0, "volume": 10.2, "weight": 11.25, "trackingNumber": "10098624220", "cartonItems": [ { "lineItemId": 92, "productCode": "SALE4-28", "batchNumber": "", "quantity": 2.0 } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "Order Id", "required": true, "schema": { "type": "integer", "description": "Order Id" } } ], "tags": [ "Cartons" ], "security": [ { "basicAuth": [] } ] }, "put": { "operationId": "PUT-Cartons-id", "summary": "Replace the list of Cartons for a Sales Order.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "boolean" }, "example": null } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "Order Id", "required": true, "schema": { "type": "integer", "description": "Order Id" } } ], "tags": [ "Cartons" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Number": { "type": "string", "description": "Carton Number. Numbers only.", "maximum": 20 }, "SSCC": { "type": "string", "description": "SSCC Number. Numbers only.", "maximum": 20, "minimum": 18 }, "Length": { "type": "number", "description": "Length" }, "Depth": { "type": "number", "description": "Depth" }, "Height": { "type": "number", "description": "Height" }, "Volume": { "type": "number", "description": "Volume" }, "Weight": { "type": "number", "description": "Weight" }, "TrackingNumber": { "type": "string", "description": "Tracking Number", "maximum": 50 }, "CartonItems": { "type": "array", "description": "Carton Items", "items": { "type": "object", "properties": { "LineItemId": { "type": "integer", "description": "Cin7 Sales Order Line Item ID" }, "ProductCode": { "type": "string", "description": "Product Code/SKU. Used to match the LineItemId if none supplied.", "maximum": 50 }, "BatchNumber": { "type": "string", "description": "Batch Number", "maximum": 50 }, "Quantity": { "type": "number", "description": "Quantity" } }, "required": [ "ProductCode", "Quantity" ] } } }, "required": [ "SSCC", "CartonItems" ] } }, "example": [ { "number": "1", "sscc": "00094219040000473889", "length": 10.2, "depth": 10.2, "height": 20.0, "volume": 10.2, "weight": 11.25, "trackingNumber": "10098624220", "cartonItems": [ { "lineItemId": 92, "productCode": "SALE4-28", "batchNumber": "", "quantity": 2.0 } ] } ] } } } } }, "/api/v1/Products/{id}": { "get": { "operationId": "GET-Products-id", "summary": "Get a Product.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 product Id." }, "Status": { "type": "string", "description": "Status: Inactive, Public, ShowInB2B, Internal", "enum": [ "Inactive", "Public", "ShowInB2B", "Internal" ] }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC", "format": "date-time" }, "StyleCode": { "type": "string", "description": "The product style code" }, "Name": { "type": "string", "description": "The product name", "maximum": 250 }, "Description": { "type": "string", "description": "The product description" }, "Tags": { "type": "string", "description": "Comma delimited list of custom tags" }, "Images": { "type": "array", "description": "A list of images", "items": { "type": "object", "properties": { "Link": { "type": "string", "description": "A link to an image" } } } }, "PdfUpload": { "type": "string", "description": "PDF file" }, "PdfDescription": { "type": "string", "description": "PDF description" }, "SupplierId": { "type": "integer", "description": "The unique Cin7 supplier Id" }, "Brand": { "type": "string", "description": "The product brand name" }, "Category": { "type": "string", "description": "Category" }, "SubCategory": { "type": "string", "description": "Subcategory" }, "CategoryIdArray": { "type": "array", "description": "Category IDs assigned to the product.", "items": { "type": "integer" } }, "Channels": { "type": "string", "description": "Selling Channels" }, "Weight": { "type": "number", "description": "The product weight", "minimum": 0.0, "maximum": 999.0 }, "Height": { "type": "number", "description": "The product height", "minimum": 0.0, "maximum": 999.0 }, "Width": { "type": "number", "description": "The product width", "minimum": 0.0, "maximum": 999.0 }, "Length": { "type": "number", "description": "The product length", "minimum": 0.0, "maximum": 999.0 }, "Volume": { "type": "number", "description": "The product volume", "minimum": 0.0, "maximum": 999.0 }, "StockControl": { "type": "string", "description": "The stock control type", "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "OrderType": { "type": "string", "description": "Order Type: Order, Kit, Limited Stock, Buy To Order, Pre-order, Gift Voucher" }, "ProductType": { "type": "string", "description": "Product Type" }, "ProductSubtype": { "type": "string", "description": "Product Subtype" }, "ProjectName": { "type": "string", "description": "Project Name" }, "OptionLabel1": { "type": "string", "description": "A label for product option name 1 (Example: Color)" }, "OptionLabel2": { "type": "string", "description": "A label for product option name 2 (Example: Size)" }, "OptionLabel3": { "type": "string", "description": "A label for product option name 3 (Example: Fabric)" }, "SalesAccount": { "type": "string", "description": "Sales account" }, "PurchasesAccount": { "type": "string", "description": "Purchase account" }, "ImportCustomsDuty": { "type": "string", "description": "Import Customs duty" }, "SizeRangeId": { "type": "integer", "description": "Size range id" }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "ProductOptions": { "type": "array", "description": "A list of product options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Product Option Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modifie Date UTC", "format": "date-time" }, "Status": { "type": "string", "description": "Product Option Status: Primary, Active or Disabled", "enum": [ "Disabled", "Primary", "Active" ] }, "ProductId": { "type": "integer", "description": "The unique Cin7 product id" }, "Code": { "type": "string", "description": "[OBSOLETE] Use ProductOptionCode", "maximum": 20 }, "Barcode": { "type": "string", "description": "[OBSOLETE] Use ProductOptionBarcode", "maximum": 13 }, "ProductOptionCode": { "type": "string", "description": "The Product Option Code/SKU", "maximum": 20 }, "ProductOptionSizeCode": { "type": "string", "description": "The Product Option Size Code/SKU", "maximum": 20 }, "ProductOptionBarcode": { "type": "string", "description": "The Product Option Barcode", "maximum": 13 }, "ProductOptionSizeBarcode": { "type": "string", "description": "The Product Option Size Barcode", "maximum": 13 }, "SupplierCode": { "type": "string", "description": "Supplier code", "maximum": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Red)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "OptionWeight": { "type": "number", "description": "Product Option Weight" }, "Size": { "type": "string", "description": "Size" }, "SizeId": { "type": "integer", "description": "Size Id" }, "RetailPrice": { "type": "number", "description": "Retail Price", "format": "currency" }, "WholesalePrice": { "type": "number", "description": "Wholesale Price", "format": "currency" }, "VIPPrice": { "type": "number", "description": "VIP Price", "format": "currency" }, "SpecialPrice": { "type": "number", "description": "Special Price", "format": "currency" }, "SpecialsStartDate": { "type": "string", "description": "Specials Start Date", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "Number of days Specials last" }, "StockAvailable": { "type": "number", "description": "Stock Available" }, "StockOnHand": { "type": "number", "description": "Stock On Hand" }, "UomOptions": { "type": "array", "description": "UOM options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 UOM Option Id" }, "ProductOptionId": { "type": "integer", "description": "The unique Cin7 Product Option Id" }, "Code": { "type": "string", "description": "The UOM option code" }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)" }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)" }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)" }, "Quantity": { "type": "number", "description": "UOM quantity" }, "Barcode": { "type": "string", "description": "The UOM option barcode" }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code" }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Image": { "type": "object", "description": "A product option image", "properties": { "Link": { "type": "string", "description": "A link to an image" } } }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } } }, "required": [ "Name" ] }, "example": { "id": 1, "status": "Public", "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "styleCode": "StyleCode", "name": "V-NECK TSHIRT", "description": "Product description...", "tags": null, "images": [ { "link": "http://cin7.com/.../product-image-1.jpg" }, { "link": "http://cin7.com/.../product-image-2.jpg" }, { "link": "http://cin7.com/.../product-image-3.jpg" } ], "pdfUpload": null, "pdfDescription": null, "supplierId": 101, "brand": "Brand Name", "category": "T-SHIRTS", "subCategory": null, "categoryIdArray": null, "channels": null, "weight": 100.0, "height": 0.0, "width": 0.0, "length": 0.0, "volume": 0.0, "stockControl": 5, "orderType": "", "productType": "", "productSubtype": null, "projectName": "", "optionLabel1": "Color", "optionLabel2": "Size", "optionLabel3": "Printed", "salesAccount": null, "purchasesAccount": null, "importCustomsDuty": null, "sizeRangeId": 0, "customFields": { "products_1000": "abc123", "products_1001": 119, "products_1002": false }, "productOptions": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Primary", "productId": 1, "code": "SKU-RED-T", "barcode": "1234567890123", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Red", "option2": "XXL", "option3": "Yes", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": 59.0, "specialsStartDate": "2026-04-18T15:23:23Z", "specialDays": 7, "stockAvailable": 4.0, "stockOnHand": 2.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-red.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Active", "productId": 1, "code": "SKU-BLUE-T", "barcode": "BARCODE-FOR-BLUE-T", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Blue", "option2": "M", "option3": "Plain", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": null, "specialsStartDate": null, "specialDays": null, "stockAvailable": 10.0, "stockOnHand": 5.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-blue.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Products" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Products": { "get": { "operationId": "GET-Products-fields_where_order_page_rows", "summary": "Get a Product.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 product Id." }, "Status": { "type": "string", "description": "Status: Inactive, Public, ShowInB2B, Internal", "enum": [ "Inactive", "Public", "ShowInB2B", "Internal" ] }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC", "format": "date-time" }, "StyleCode": { "type": "string", "description": "The product style code" }, "Name": { "type": "string", "description": "The product name", "maximum": 250 }, "Description": { "type": "string", "description": "The product description" }, "Tags": { "type": "string", "description": "Comma delimited list of custom tags" }, "Images": { "type": "array", "description": "A list of images", "items": { "type": "object", "properties": { "Link": { "type": "string", "description": "A link to an image" } } } }, "PdfUpload": { "type": "string", "description": "PDF file" }, "PdfDescription": { "type": "string", "description": "PDF description" }, "SupplierId": { "type": "integer", "description": "The unique Cin7 supplier Id" }, "Brand": { "type": "string", "description": "The product brand name" }, "Category": { "type": "string", "description": "Category" }, "SubCategory": { "type": "string", "description": "Subcategory" }, "CategoryIdArray": { "type": "array", "description": "Category IDs assigned to the product.", "items": { "type": "integer" } }, "Channels": { "type": "string", "description": "Selling Channels" }, "Weight": { "type": "number", "description": "The product weight", "minimum": 0.0, "maximum": 999.0 }, "Height": { "type": "number", "description": "The product height", "minimum": 0.0, "maximum": 999.0 }, "Width": { "type": "number", "description": "The product width", "minimum": 0.0, "maximum": 999.0 }, "Length": { "type": "number", "description": "The product length", "minimum": 0.0, "maximum": 999.0 }, "Volume": { "type": "number", "description": "The product volume", "minimum": 0.0, "maximum": 999.0 }, "StockControl": { "type": "string", "description": "The stock control type", "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "OrderType": { "type": "string", "description": "Order Type: Order, Kit, Limited Stock, Buy To Order, Pre-order, Gift Voucher" }, "ProductType": { "type": "string", "description": "Product Type" }, "ProductSubtype": { "type": "string", "description": "Product Subtype" }, "ProjectName": { "type": "string", "description": "Project Name" }, "OptionLabel1": { "type": "string", "description": "A label for product option name 1 (Example: Color)" }, "OptionLabel2": { "type": "string", "description": "A label for product option name 2 (Example: Size)" }, "OptionLabel3": { "type": "string", "description": "A label for product option name 3 (Example: Fabric)" }, "SalesAccount": { "type": "string", "description": "Sales account" }, "PurchasesAccount": { "type": "string", "description": "Purchase account" }, "ImportCustomsDuty": { "type": "string", "description": "Import Customs duty" }, "SizeRangeId": { "type": "integer", "description": "Size range id" }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "ProductOptions": { "type": "array", "description": "A list of product options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Product Option Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modifie Date UTC", "format": "date-time" }, "Status": { "type": "string", "description": "Product Option Status: Primary, Active or Disabled", "enum": [ "Disabled", "Primary", "Active" ] }, "ProductId": { "type": "integer", "description": "The unique Cin7 product id" }, "Code": { "type": "string", "description": "[OBSOLETE] Use ProductOptionCode", "maximum": 20 }, "Barcode": { "type": "string", "description": "[OBSOLETE] Use ProductOptionBarcode", "maximum": 13 }, "ProductOptionCode": { "type": "string", "description": "The Product Option Code/SKU", "maximum": 20 }, "ProductOptionSizeCode": { "type": "string", "description": "The Product Option Size Code/SKU", "maximum": 20 }, "ProductOptionBarcode": { "type": "string", "description": "The Product Option Barcode", "maximum": 13 }, "ProductOptionSizeBarcode": { "type": "string", "description": "The Product Option Size Barcode", "maximum": 13 }, "SupplierCode": { "type": "string", "description": "Supplier code", "maximum": 20 }, "Option1": { "type": "string", "description": "Product option 1 (Example: Red)", "maximum": 50 }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)", "maximum": 50 }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)", "maximum": 50 }, "OptionWeight": { "type": "number", "description": "Product Option Weight" }, "Size": { "type": "string", "description": "Size" }, "SizeId": { "type": "integer", "description": "Size Id" }, "RetailPrice": { "type": "number", "description": "Retail Price", "format": "currency" }, "WholesalePrice": { "type": "number", "description": "Wholesale Price", "format": "currency" }, "VIPPrice": { "type": "number", "description": "VIP Price", "format": "currency" }, "SpecialPrice": { "type": "number", "description": "Special Price", "format": "currency" }, "SpecialsStartDate": { "type": "string", "description": "Specials Start Date", "format": "date-time" }, "SpecialDays": { "type": "integer", "description": "Number of days Specials last" }, "StockAvailable": { "type": "number", "description": "Stock Available" }, "StockOnHand": { "type": "number", "description": "Stock On Hand" }, "UomOptions": { "type": "array", "description": "UOM options", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 UOM Option Id" }, "ProductOptionId": { "type": "integer", "description": "The unique Cin7 Product Option Id" }, "Code": { "type": "string", "description": "The UOM option code" }, "Option1": { "type": "string", "description": "Product option 1 (Example: Box)" }, "Option2": { "type": "string", "description": "Product option 2 (Example: XL)" }, "Option3": { "type": "string", "description": "Product option 3 (Example: Cotton)" }, "Quantity": { "type": "number", "description": "UOM quantity" }, "Barcode": { "type": "string", "description": "The UOM option barcode" }, "SupplierCode": { "type": "string", "description": "The UOM option Supplier code" }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Image": { "type": "object", "description": "A product option image", "properties": { "Link": { "type": "string", "description": "A link to an image" } } }, "PriceColumns": { "type": "array", "description": "Price Columns", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } } }, "required": [ "Name" ] } }, "example": [ { "id": 1, "status": "Public", "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "styleCode": "StyleCode", "name": "V-NECK TSHIRT", "description": "Product description...", "tags": null, "images": [ { "link": "http://cin7.com/.../product-image-1.jpg" }, { "link": "http://cin7.com/.../product-image-2.jpg" }, { "link": "http://cin7.com/.../product-image-3.jpg" } ], "pdfUpload": null, "pdfDescription": null, "supplierId": 101, "brand": "Brand Name", "category": "T-SHIRTS", "subCategory": null, "categoryIdArray": null, "channels": null, "weight": 100.0, "height": 0.0, "width": 0.0, "length": 0.0, "volume": 0.0, "stockControl": 5, "orderType": "", "productType": "", "productSubtype": null, "projectName": "", "optionLabel1": "Color", "optionLabel2": "Size", "optionLabel3": "Printed", "salesAccount": null, "purchasesAccount": null, "importCustomsDuty": null, "sizeRangeId": 0, "customFields": { "products_1000": "abc123", "products_1001": 119, "products_1002": false }, "productOptions": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Primary", "productId": 1, "code": "SKU-RED-T", "barcode": "1234567890123", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Red", "option2": "XXL", "option3": "Yes", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": 59.0, "specialsStartDate": "2026-04-18T15:23:23Z", "specialDays": 7, "stockAvailable": 4.0, "stockOnHand": 2.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-red.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } }, { "id": 2, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "status": "Active", "productId": 1, "code": "SKU-BLUE-T", "barcode": "BARCODE-FOR-BLUE-T", "productOptionCode": null, "productOptionSizeCode": null, "productOptionBarcode": null, "productOptionSizeBarcode": null, "supplierCode": "SUPPLIER-CODE", "option1": "Blue", "option2": "M", "option3": "Plain", "optionWeight": 0.0, "size": null, "sizeId": 0, "retailPrice": 89.9, "wholesalePrice": 25.0, "vipPrice": 79.0, "specialPrice": null, "specialsStartDate": null, "specialDays": null, "stockAvailable": 10.0, "stockOnHand": 5.0, "uomOptions": [], "image": { "link": "http://cin7.com/.../product-option-image-blue.jpg" }, "priceColumns": { "priceAUD": 20.0, "priceGBP": 119.0, "costNZD": 15.0 } } ] }, { "id": 0, "status": "Inactive", "createdDate": "0001-01-01T00:00:00Z", "modifiedDate": "0001-01-01T00:00:00Z", "styleCode": null, "name": null, "description": null, "tags": null, "images": [], "pdfUpload": null, "pdfDescription": null, "supplierId": 0, "brand": null, "category": null, "subCategory": null, "categoryIdArray": null, "channels": null, "weight": 0.0, "height": 0.0, "width": 0.0, "length": 0.0, "volume": 0.0, "stockControl": 0, "orderType": null, "productType": null, "productSubtype": null, "projectName": null, "optionLabel1": null, "optionLabel2": null, "optionLabel3": null, "salesAccount": null, "purchasesAccount": null, "importCustomsDuty": null, "sizeRangeId": 0, "customFields": null, "productOptions": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Products" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Products-", "summary": "Creates a list of Products. \r\n Duplicated style codes or product option code in the request will cause the request to be rejected with a 400. \r\n If a product with the same style code or product option code already exists, it will be skipped and not created.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Products" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Name": { "type": "string", "description": "The product name", "maximum": 250 }, "Status": { "type": "string", "description": "Will default to Public if not set.\r\n Status: Public, Inactive, ShowInB2B, Internal", "enum": [ "Inactive", "Public", "ShowInB2B", "Internal" ] }, "StyleCode": { "type": "string", "description": "The Product style code", "maximum": 250 }, "Description": { "type": "string", "description": "The product description", "maximum": 250 }, "StockControl": { "type": "string", "description": "Will default to FIFO if not set.\r\n Stock control: FIFO, Batch, Machine, Serial, Labour", "enum": [ "Undefined", "Batch", "Machine", "Serial", "Labour", "FIFO" ] }, "OrderType": { "type": "string", "description": "Will default to Order if not set.\r\n Order Type: Order, Kit, Limited Stock, Buy To Order, Pre-order, Gift Voucher", "enum": [ "Order", "Kit", "Limited Stock", "Buy To Order", "Pre-order", "Gift Voucher" ] }, "Brand": { "type": "string", "description": "The product brand name. Allow users to assign a brand name based on their preference. This doesn’t need to be part of the existing list of brands present in the backend.", "maximum": 250 }, "OptionLabel1": { "type": "string", "description": "A label for the first product option (e.g., Color).", "maximum": 250 }, "OptionLabel2": { "type": "string", "description": "A label for the second product option (e.g., Size).", "maximum": 250 }, "OptionLabel3": { "type": "string", "description": "A label for the third product option (e.g., Fabric).", "maximum": 250 }, "SalesAccount": { "type": "string", "description": "The sales account associated with the product.", "maximum": 250 }, "PurchasesAccount": { "type": "string", "description": "The purchase account associated with the product.", "maximum": 250 }, "ImportCustomsDuty": { "type": "string", "description": "The import customs duty applicable to the product.", "maximum": 250 }, "CategoryIdArray": { "type": "array", "description": "Array of category IDs assigned to the product.", "items": { "type": "integer" } }, "Dimensions": { "type": "object", "description": "Dimensions of the product like weight, height, width, length, volume", "properties": { "Weight": { "type": "number", "description": "The product weight", "minimum": 0.0, "maximum": 999.0 }, "Height": { "type": "number", "description": "The product height", "minimum": 0.0, "maximum": 999.0 }, "Width": { "type": "number", "description": "The product width", "minimum": 0.0, "maximum": 999.0 }, "Length": { "type": "number", "description": "The product length", "minimum": 0.0, "maximum": 999.0 }, "Volume": { "type": "number", "description": "The product volume", "minimum": 0.0, "maximum": 999.0 } } }, "ProductOptions": { "type": "array", "description": "Prices and Costs of the product.\r\n *Only ONE Product Option* is supported at this time.", "items": { "type": "object", "properties": { "ProductOptionCode": { "type": "string", "description": "Code for this product option.\r\n If not set, an identifier will be generated for it.", "maximum": 50 }, "RetailPrice": { "type": "number", "description": "Retail Price of the product", "minimum": 0.0, "maximum": 1.7976931348623157E+308 }, "Cost": { "type": "number", "description": "The product cost", "minimum": 0.0, "maximum": 1.7976931348623157E+308 } } }, "maximum": 1, "minimum": 1 }, "SizeRangeId": { "type": "integer", "description": "The Id of the Size Range. This can be obtained from the GetSizeRanges Endpoint" } }, "required": [ "Name", "ProductOptions" ] } }, "example": [ { "name": "sample string 1", "status": "Inactive", "styleCode": "sample string 2", "description": "sample string 3", "stockControl": "Undefined", "orderType": "sample string 4", "brand": "sample string 5", "optionLabel1": "sample string 6", "optionLabel2": "sample string 7", "optionLabel3": "sample string 8", "salesAccount": "sample string 9", "purchasesAccount": "sample string 10", "importCustomsDuty": "sample string 11", "categoryIdArray": [ 1, 2 ], "dimensions": { "weight": 1.0, "height": 1.0, "width": 1.0, "length": 1.0, "volume": 1.0 }, "productOptions": [ { "productOptionCode": "sample string 1", "retailPrice": 2.0, "cost": 3.0 }, { "productOptionCode": "sample string 1", "retailPrice": 2.0, "cost": 3.0 } ], "sizeRangeId": 12 }, { "name": "sample string 1", "status": "Inactive", "styleCode": "sample string 2", "description": "sample string 3", "stockControl": "Undefined", "orderType": "sample string 4", "brand": "sample string 5", "optionLabel1": "sample string 6", "optionLabel2": "sample string 7", "optionLabel3": "sample string 8", "salesAccount": "sample string 9", "purchasesAccount": "sample string 10", "importCustomsDuty": "sample string 11", "categoryIdArray": [ 1, 2 ], "dimensions": { "weight": 1.0, "height": 1.0, "width": 1.0, "length": 1.0, "volume": 1.0 }, "productOptions": [ { "productOptionCode": "sample string 1", "retailPrice": 2.0, "cost": 3.0 }, { "productOptionCode": "sample string 1", "retailPrice": 2.0, "cost": 3.0 } ], "sizeRangeId": 12 } ] } } } }, "put": { "operationId": "PUT-Products-", "summary": "Updates a list of Products.\r\n If a product with the same style code or product option code already exists, it will be skipped and not updated.\r\n Leave fields empty to clear them, leave fields null to not update them.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Products" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": null, "minimum": 1.0, "maximum": 2147483647.0 }, "Name": { "type": "string", "description": null, "maximum": 250, "minimum": 2 }, "Status": { "type": "string", "description": "Will default to Public if not set.\r\n Status: Public, Inactive, ShowInB2B, Internal", "enum": [ "Inactive", "Public", "ShowInB2B", "Internal" ] }, "Description": { "type": "string", "description": null, "maximum": 250 }, "StyleCode": { "type": "string", "description": null, "maximum": 250 }, "Brand": { "type": "string", "description": "The product brand name. Allow users to assign a brand name based on their preference. This doesn’t need to be part of the existing list of brands present in the backend.", "maximum": 250 }, "OptionLabel1": { "type": "string", "description": "A label for the first product option (e.g., Color).", "maximum": 250 }, "OptionLabel2": { "type": "string", "description": "A label for the second product option (e.g., Size).", "maximum": 250 }, "OptionLabel3": { "type": "string", "description": "A label for the third product option (e.g., Fabric).", "maximum": 250 }, "SalesAccount": { "type": "string", "description": "The sales account associated with the product.", "maximum": 250 }, "PurchasesAccount": { "type": "string", "description": "The purchase account associated with the product.", "maximum": 250 }, "ImportCustomsDuty": { "type": "string", "description": "The import customs duty applicable to the product.", "maximum": 250 }, "SizeRangeId": { "type": "integer", "description": "The id of the Size Range available in Omni account." }, "CategoryIdArray": { "type": "array", "description": "Array of category IDs assigned to the product.", "items": { "type": "integer" } }, "ProductDimensions": { "type": "object", "description": null, "properties": { "Weight": { "type": "number", "description": null, "minimum": 0.0, "maximum": 999.0 }, "Height": { "type": "number", "description": null, "minimum": 0.0, "maximum": 999.0 }, "Width": { "type": "number", "description": null, "minimum": 0.0, "maximum": 999.0 }, "Length": { "type": "number", "description": null, "minimum": 0.0, "maximum": 999.0 }, "Volume": { "type": "number", "description": null, "minimum": 0.0, "maximum": 999.0 } } } }, "required": [ "Id" ] } }, "example": [ { "id": 1, "name": "sample string 2", "status": "Inactive", "description": "sample string 3", "styleCode": "sample string 4", "brand": "sample string 5", "optionLabel1": "sample string 6", "optionLabel2": "sample string 7", "optionLabel3": "sample string 8", "salesAccount": "sample string 9", "purchasesAccount": "sample string 10", "importCustomsDuty": "sample string 11", "sizeRangeId": 1, "categoryIdArray": [ 1, 2 ], "productDimensions": { "weight": 1.0, "height": 1.0, "width": 1.0, "length": 1.0, "volume": 1.0 } }, { "id": 1, "name": "sample string 2", "status": "Inactive", "description": "sample string 3", "styleCode": "sample string 4", "brand": "sample string 5", "optionLabel1": "sample string 6", "optionLabel2": "sample string 7", "optionLabel3": "sample string 8", "salesAccount": "sample string 9", "purchasesAccount": "sample string 10", "importCustomsDuty": "sample string 11", "sizeRangeId": 1, "categoryIdArray": [ 1, 2 ], "productDimensions": { "weight": 1.0, "height": 1.0, "width": 1.0, "length": 1.0, "volume": 1.0 } } ] } } } } }, "/api/v1/Quotes/{id}": { "get": { "operationId": "GET-Quotes-id", "summary": "Get a Quote", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Probability of Winning" }, "ExpectedOrderDate": { "type": "string", "description": "Expected Order Date", "format": "date-time" }, "AcceptanceDate": { "type": "string", "description": "Acceptance Date", "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": null, "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "probability": 0.0, "expectedOrderDate": null, "acceptanceDate": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 1, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "TEST", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 5.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 20.0, "discount": 10.0, "qtyShipped": 0.0, "holdingQty": 0.0 } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Quotes" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Quotes": { "get": { "operationId": "GET-Quotes-fields_where_order_page_rows", "summary": "Get a Quote", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Probability of Winning" }, "ExpectedOrderDate": { "type": "string", "description": "Expected Order Date", "format": "date-time" }, "AcceptanceDate": { "type": "string", "description": "Acceptance Date", "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": null, "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": "", "projectName": null, "trackingCode": "", "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "memberEmail": "", "memberCostCenter": "", "memberAlternativeTaxRate": null, "costCenter": "", "alternativeTaxRate": null, "estimatedDeliveryDate": null, "salesPersonId": 0, "salesPersonEmail": "", "paymentTerms": "", "customerOrderNo": "", "voucherCode": "", "deliveryInstructions": "Leave at the door, beware the dog.", "cancellationDate": null, "modifiedCOGSDate": null, "status": "DRAFT", "stage": "New", "probability": 0.0, "expectedOrderDate": null, "acceptanceDate": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 1, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "TEST", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 5.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 20.0, "discount": 10.0, "qtyShipped": 0.0, "holdingQty": 0.0 } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Quotes" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Quotes-loadboms", "summary": "Create a list of Quotes", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "Quotes" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Probability of Winning" }, "ExpectedOrderDate": { "type": "string", "description": "Expected Order Date", "format": "date-time" }, "AcceptanceDate": { "type": "string", "description": "Acceptance Date", "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 14, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 15, "processedBy": 16, "isApproved": true, "reference": "sample string 18", "memberId": 19, "firstName": "sample string 20", "lastName": "sample string 21", "company": "sample string 22", "email": "sample string 23", "phone": "sample string 24", "mobile": "sample string 25", "fax": "sample string 26", "deliveryFirstName": "sample string 27", "deliveryLastName": "sample string 28", "deliveryCompany": "sample string 29", "deliveryAddress1": "sample string 30", "deliveryAddress2": "sample string 31", "deliveryCity": "sample string 32", "deliveryState": "sample string 33", "deliveryPostalCode": "sample string 34", "deliveryCountry": "sample string 35", "billingFirstName": "sample string 36", "billingLastName": "sample string 37", "billingCompany": "sample string 38", "billingAddress1": "sample string 39", "billingAddress2": "sample string 40", "billingCity": "sample string 41", "billingPostalCode": "sample string 42", "billingState": "sample string 43", "billingCountry": "sample string 44", "branchId": 45, "branchEmail": "sample string 46", "projectName": "sample string 47", "trackingCode": "sample string 48", "internalComments": "sample string 49", "productTotal": 50.0, "freightTotal": 1.0, "freightDescription": "sample string 51", "surcharge": 1.0, "surchargeDescription": "sample string 52", "discountTotal": 1.0, "discountDescription": "sample string 53", "total": 54.0, "currencyCode": "sample string 56", "currencyRate": 57.0, "currencySymbol": "sample string 58", "taxStatus": "Undefined", "taxRate": 59.0, "source": "sample string 60", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 3", "memberCostCenter": "sample string 4", "memberAlternativeTaxRate": "sample string 5", "costCenter": "sample string 6", "alternativeTaxRate": "sample string 7", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 8, "salesPersonEmail": "sample string 9", "paymentTerms": "sample string 10", "customerOrderNo": "sample string 11", "voucherCode": "sample string 12", "deliveryInstructions": "sample string 13", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 2", "probability": 1.0, "expectedOrderDate": "2026-04-20T05:47:08Z", "acceptanceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 } ] }, { "id": 14, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 15, "processedBy": 16, "isApproved": true, "reference": "sample string 18", "memberId": 19, "firstName": "sample string 20", "lastName": "sample string 21", "company": "sample string 22", "email": "sample string 23", "phone": "sample string 24", "mobile": "sample string 25", "fax": "sample string 26", "deliveryFirstName": "sample string 27", "deliveryLastName": "sample string 28", "deliveryCompany": "sample string 29", "deliveryAddress1": "sample string 30", "deliveryAddress2": "sample string 31", "deliveryCity": "sample string 32", "deliveryState": "sample string 33", "deliveryPostalCode": "sample string 34", "deliveryCountry": "sample string 35", "billingFirstName": "sample string 36", "billingLastName": "sample string 37", "billingCompany": "sample string 38", "billingAddress1": "sample string 39", "billingAddress2": "sample string 40", "billingCity": "sample string 41", "billingPostalCode": "sample string 42", "billingState": "sample string 43", "billingCountry": "sample string 44", "branchId": 45, "branchEmail": "sample string 46", "projectName": "sample string 47", "trackingCode": "sample string 48", "internalComments": "sample string 49", "productTotal": 50.0, "freightTotal": 1.0, "freightDescription": "sample string 51", "surcharge": 1.0, "surchargeDescription": "sample string 52", "discountTotal": 1.0, "discountDescription": "sample string 53", "total": 54.0, "currencyCode": "sample string 56", "currencyRate": 57.0, "currencySymbol": "sample string 58", "taxStatus": "Undefined", "taxRate": 59.0, "source": "sample string 60", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 3", "memberCostCenter": "sample string 4", "memberAlternativeTaxRate": "sample string 5", "costCenter": "sample string 6", "alternativeTaxRate": "sample string 7", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 8, "salesPersonEmail": "sample string 9", "paymentTerms": "sample string 10", "customerOrderNo": "sample string 11", "voucherCode": "sample string 12", "deliveryInstructions": "sample string 13", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 2", "probability": 1.0, "expectedOrderDate": "2026-04-20T05:47:08Z", "acceptanceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 } ] } ] } } } }, "put": { "operationId": "PUT-Quotes-loadboms", "summary": "Update a list of Quotes", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "loadboms", "in": "query", "description": "An option to expand BOM's (This cannot be undone)", "required": false, "schema": { "type": "boolean", "description": "An option to expand BOM's (This cannot be undone)" } } ], "tags": [ "Quotes" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Probability": { "type": "number", "description": "Probability of Winning" }, "ExpectedOrderDate": { "type": "string", "description": "Expected Order Date", "format": "date-time" }, "AcceptanceDate": { "type": "string", "description": "Acceptance Date", "format": "date-time" }, "LineItems": { "type": "array", "description": null, "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "HoldingQty": { "type": "number", "description": "Holding Quantity (read-only)." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "Status": { "type": "string", "description": "Status - (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "Stage": { "type": "string", "description": "Stage: New, Awaiting Payment, Declined, Dispatched, Processing, On Hold (default: New)" }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer in an order", "maximum": 250 }, "MemberCostCenter": { "type": "string", "description": "Member Cost Center (Alternative GL Account)." }, "MemberAlternativeTaxRate": { "type": "string", "description": "The member Alternative Tax Rate." }, "CostCenter": { "type": "string", "description": "Cost Center (Alternative GL Account)." }, "AlternativeTaxRate": { "type": "string", "description": "Alternative Tax Rate." }, "EstimatedDeliveryDate": { "type": "string", "description": "Estimated Delivery Date", "format": "date-time" }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "SalesPersonEmail": { "type": "string", "description": "Made obsolete. This value will be null in the response.", "maximum": 250 }, "PaymentTerms": { "type": "string", "description": "Payment terms" }, "CustomerOrderNo": { "type": "string", "description": "Customer purchase order reference" }, "VoucherCode": { "type": "string", "description": "Voucher code", "maximum": 30 }, "DeliveryInstructions": { "type": "string", "description": "Delivery instructions e.g. Leave at the door, beware the dog.", "maximum": 2000 }, "CancellationDate": { "type": "string", "description": "Order cancellation date - (Read-only)", "format": "date-time" }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "id": 14, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 15, "processedBy": 16, "isApproved": true, "reference": "sample string 18", "memberId": 19, "firstName": "sample string 20", "lastName": "sample string 21", "company": "sample string 22", "email": "sample string 23", "phone": "sample string 24", "mobile": "sample string 25", "fax": "sample string 26", "deliveryFirstName": "sample string 27", "deliveryLastName": "sample string 28", "deliveryCompany": "sample string 29", "deliveryAddress1": "sample string 30", "deliveryAddress2": "sample string 31", "deliveryCity": "sample string 32", "deliveryState": "sample string 33", "deliveryPostalCode": "sample string 34", "deliveryCountry": "sample string 35", "billingFirstName": "sample string 36", "billingLastName": "sample string 37", "billingCompany": "sample string 38", "billingAddress1": "sample string 39", "billingAddress2": "sample string 40", "billingCity": "sample string 41", "billingPostalCode": "sample string 42", "billingState": "sample string 43", "billingCountry": "sample string 44", "branchId": 45, "branchEmail": "sample string 46", "projectName": "sample string 47", "trackingCode": "sample string 48", "internalComments": "sample string 49", "productTotal": 50.0, "freightTotal": 1.0, "freightDescription": "sample string 51", "surcharge": 1.0, "surchargeDescription": "sample string 52", "discountTotal": 1.0, "discountDescription": "sample string 53", "total": 54.0, "currencyCode": "sample string 56", "currencyRate": 57.0, "currencySymbol": "sample string 58", "taxStatus": "Undefined", "taxRate": 59.0, "source": "sample string 60", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 3", "memberCostCenter": "sample string 4", "memberAlternativeTaxRate": "sample string 5", "costCenter": "sample string 6", "alternativeTaxRate": "sample string 7", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 8, "salesPersonEmail": "sample string 9", "paymentTerms": "sample string 10", "customerOrderNo": "sample string 11", "voucherCode": "sample string 12", "deliveryInstructions": "sample string 13", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 2", "probability": 1.0, "expectedOrderDate": "2026-04-20T05:47:08Z", "acceptanceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 } ] }, { "id": 14, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 15, "processedBy": 16, "isApproved": true, "reference": "sample string 18", "memberId": 19, "firstName": "sample string 20", "lastName": "sample string 21", "company": "sample string 22", "email": "sample string 23", "phone": "sample string 24", "mobile": "sample string 25", "fax": "sample string 26", "deliveryFirstName": "sample string 27", "deliveryLastName": "sample string 28", "deliveryCompany": "sample string 29", "deliveryAddress1": "sample string 30", "deliveryAddress2": "sample string 31", "deliveryCity": "sample string 32", "deliveryState": "sample string 33", "deliveryPostalCode": "sample string 34", "deliveryCountry": "sample string 35", "billingFirstName": "sample string 36", "billingLastName": "sample string 37", "billingCompany": "sample string 38", "billingAddress1": "sample string 39", "billingAddress2": "sample string 40", "billingCity": "sample string 41", "billingPostalCode": "sample string 42", "billingState": "sample string 43", "billingCountry": "sample string 44", "branchId": 45, "branchEmail": "sample string 46", "projectName": "sample string 47", "trackingCode": "sample string 48", "internalComments": "sample string 49", "productTotal": 50.0, "freightTotal": 1.0, "freightDescription": "sample string 51", "surcharge": 1.0, "surchargeDescription": "sample string 52", "discountTotal": 1.0, "discountDescription": "sample string 53", "total": 54.0, "currencyCode": "sample string 56", "currencyRate": 57.0, "currencySymbol": "sample string 58", "taxStatus": "Undefined", "taxRate": 59.0, "source": "sample string 60", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 3", "memberCostCenter": "sample string 4", "memberAlternativeTaxRate": "sample string 5", "costCenter": "sample string 6", "alternativeTaxRate": "sample string 7", "estimatedDeliveryDate": "2026-04-20T05:47:08Z", "salesPersonId": 8, "salesPersonEmail": "sample string 9", "paymentTerms": "sample string 10", "customerOrderNo": "sample string 11", "voucherCode": "sample string 12", "deliveryInstructions": "sample string 13", "cancellationDate": "2026-04-20T05:47:08Z", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "stage": "sample string 2", "probability": 1.0, "expectedOrderDate": "2026-04-20T05:47:08Z", "acceptanceDate": "2026-04-20T05:47:08Z", "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "holdingQty": 8.0 } ] } ] } } } } }, "/api/v1/CreditNotes/{id}": { "get": { "operationId": "GET-CreditNotes-id", "summary": "Get a Credit Note.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Status": { "type": "string", "description": "Status (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer.", "maximum": 250 }, "SalesReference": { "type": "string", "description": "The Sales Order reference.", "maximum": 50 }, "CreditNoteNumber": { "type": "integer", "description": "Credit note number (Read-only)" }, "CreditNoteDate": { "type": "string", "description": "Credit Note Date. Send to 3rd party accounting system no earlier than this date.", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "CustomerReport": { "type": "string", "description": "​Notes to customer e.g. the reason for issuing a Credit Note." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Attributes", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } }, "required": [ "SalesReference" ] }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "CRN-447", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": null, "projectName": null, "trackingCode": null, "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "memberEmail": null, "modifiedCOGSDate": null, "status": "DRAFT", "salesReference": "SALE4-28", "creditNoteNumber": 0, "creditNoteDate": null, "completedDate": "2026-04-19T00:00:00Z", "customerReport": null, "alternativeAccountCode": null, "salesPersonId": 0, "logisticsCarrier": null, "logisticsStatus": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "discount": 0.0, "qtyShipped": 0.0, "accountCode": null }, { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 2, "integrationRef": "LineItem2", "sort": 2, "code": "", "name": "V-NECK TSHIRT", "option1": "Blue", "option2": "M", "option3": "Plain", "qty": 1.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 89.9, "discount": 10.0, "qtyShipped": 0.0, "accountCode": null } ], "accountingAttributes": null } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "CreditNotes" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/CreditNotes": { "get": { "operationId": "GET-CreditNotes-fields_where_order_page_rows", "summary": "Get a Credit Note.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": "Status (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer.", "maximum": 250 }, "SalesReference": { "type": "string", "description": "The Sales Order reference.", "maximum": 50 }, "CreditNoteNumber": { "type": "integer", "description": "Credit note number (Read-only)" }, "CreditNoteDate": { "type": "string", "description": "Credit Note Date. Send to 3rd party accounting system no earlier than this date.", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "CustomerReport": { "type": "string", "description": "​Notes to customer e.g. the reason for issuing a Credit Note." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Attributes", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } }, "required": [ "SalesReference" ] } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "CRN-447", "memberId": 0, "firstName": "Alex", "lastName": "Smith", "company": "Alex's Company", "email": "alex@acompany.com", "phone": "(000) 123-4567", "mobile": "(000) 123-4567", "fax": "(000) 123-4567", "deliveryFirstName": "Bob", "deliveryLastName": "Joans", "deliveryCompany": "Bob's Company", "deliveryAddress1": "Delivery Address Line 1", "deliveryAddress2": "Delivery Address Line 2", "deliveryCity": "Delivery City", "deliveryState": "Delivery State", "deliveryPostalCode": "Postal Code", "deliveryCountry": "Australia", "billingFirstName": "Alex", "billingLastName": "Smith", "billingCompany": "Alex's Company", "billingAddress1": "BillingAddress1", "billingAddress2": "BillingAddress2", "billingCity": "BillingCity", "billingPostalCode": "BillingPostalCode", "billingState": "BillingState", "billingCountry": "USA", "branchId": 0, "branchEmail": null, "projectName": null, "trackingCode": null, "internalComments": null, "productTotal": 0.0, "freightTotal": 0.0, "freightDescription": "Fedex", "surcharge": 0.0, "surchargeDescription": "", "discountTotal": 0.0, "discountDescription": null, "total": 0.0, "currencyCode": "USD", "currencyRate": 1.0, "currencySymbol": "$", "taxStatus": "Incl", "taxRate": 6.5, "source": null, "customFields": null, "memberEmail": null, "modifiedCOGSDate": null, "status": "DRAFT", "salesReference": "SALE4-28", "creditNoteNumber": 0, "creditNoteDate": null, "completedDate": "2026-04-19T00:00:00Z", "customerReport": null, "alternativeAccountCode": null, "salesPersonId": 0, "logisticsCarrier": null, "logisticsStatus": null, "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": "LineItem1", "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 59.0, "discount": 0.0, "qtyShipped": 0.0, "accountCode": null }, { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 2, "integrationRef": "LineItem2", "sort": 2, "code": "", "name": "V-NECK TSHIRT", "option1": "Blue", "option2": "M", "option3": "Plain", "qty": 1.0, "styleCode": "", "barcode": "", "sizeCodes": null, "lineComments": "Comment...", "unitCost": null, "unitPrice": 89.9, "discount": 10.0, "qtyShipped": 0.0, "accountCode": null } ], "accountingAttributes": null } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "CreditNotes" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-CreditNotes-", "summary": "Create a list of Credit Notes.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "CreditNotes" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": "Status (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer.", "maximum": 250 }, "SalesReference": { "type": "string", "description": "The Sales Order reference.", "maximum": 50 }, "CreditNoteNumber": { "type": "integer", "description": "Credit note number (Read-only)" }, "CreditNoteDate": { "type": "string", "description": "Credit Note Date. Send to 3rd party accounting system no earlier than this date.", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "CustomerReport": { "type": "string", "description": "​Notes to customer e.g. the reason for issuing a Credit Note." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Attributes", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } }, "required": [ "SalesReference" ] } }, "example": [ { "id": 8, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" } }, { "id": 8, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" } } ] } } } }, "put": { "operationId": "PUT-CreditNotes-", "summary": "Update a list of Credit Notes.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "CreditNotes" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Status": { "type": "string", "description": "Status (Read-only)", "enum": [ "Draft", "Approved", "Void" ] }, "MemberEmail": { "type": "string", "description": "The CRM contact email of a customer.", "maximum": 250 }, "SalesReference": { "type": "string", "description": "The Sales Order reference.", "maximum": 50 }, "CreditNoteNumber": { "type": "integer", "description": "Credit note number (Read-only)" }, "CreditNoteDate": { "type": "string", "description": "Credit Note Date. Send to 3rd party accounting system no earlier than this date.", "format": "date-time" }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "CustomerReport": { "type": "string", "description": "​Notes to customer e.g. the reason for issuing a Credit Note." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "SalesPersonId": { "type": "integer", "description": "The unique Cin7 user Id of the sales person." }, "LogisticsCarrier": { "type": "string", "description": "Logistics Carrier" }, "LogisticsStatus": { "type": "integer", "description": "Logistics Status" }, "LineItems": { "type": "array", "description": "Line Items", "items": { "type": "object", "properties": { "StyleCode": { "type": "string", "description": "Product style code" }, "Barcode": { "type": "string", "description": "Barcode/UPC. Note, if the product option barode exists in Cin7, only quantity needs to be included; all other fields are optional." }, "SizeCodes": { "type": "string", "description": "An array of size quantities and codes e.g. Qty|Size|Code|Barcode. (Note this is Read-Only)" }, "LineComments": { "type": "string", "description": "Line item comment" }, "UnitCost": { "type": "number", "description": "Unit Cost" }, "UnitPrice": { "type": "number", "description": "Unit Price" }, "Discount": { "type": "number", "description": "Total line item discount" }, "QtyShipped": { "type": "number", "description": "​Qty shipped/dispatched. This field is read-only. Populate 'DispatchedDate' to update this field. ​" }, "AccountCode": { "type": "string", "description": "Alternative GL Account Code." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } }, "AccountingAttributes": { "type": "object", "description": "This is for the Accounting Attributes", "properties": { "ImportDate": { "type": "string", "description": "The date an invoice was imported to a Cin7 accounts accounting software.", "format": "date-time" }, "AccountingImportStatus": { "type": "string", "description": "This refers to the Accounting Invoice Status of the order in Cin7.", "enum": [ "NotImported", "Imported", "DoNotImport", "Error" ] } } }, "ModifiedCOGSDate": { "type": "string", "description": "Last modified date of Cost of Good Sold(COGS) - (Read-only)", "format": "date-time" }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created date.", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Last modified date.", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 30 }, "MemberId": { "type": "integer", "description": "The Customer Id (Optional). MemberId or MemberEmail should be specified to link a member to the order." }, "FirstName": { "type": "string", "description": "Contact first name", "maximum": 250 }, "LastName": { "type": "string", "description": "Contact last name", "maximum": 250 }, "Company": { "type": "string", "description": "Contact company", "maximum": 250 }, "Email": { "type": "string", "description": "Contact email address, could be different from MemberEmail assigned to the order", "maximum": 250 }, "Phone": { "type": "string", "description": "Contact phone", "maximum": 50 }, "Mobile": { "type": "string", "description": "Contact mobile", "maximum": 50 }, "Fax": { "type": "string", "description": "Contact fax", "maximum": 50 }, "DeliveryFirstName": { "type": "string", "description": "Delivery recipient first name", "maximum": 250 }, "DeliveryLastName": { "type": "string", "description": "Delivery recipient last name", "maximum": 250 }, "DeliveryCompany": { "type": "string", "description": "Delivery recipient company name", "maximum": 250 }, "DeliveryAddress1": { "type": "string", "description": "Delivery address 1", "maximum": 250 }, "DeliveryAddress2": { "type": "string", "description": "Delivery address 2", "maximum": 250 }, "DeliveryCity": { "type": "string", "description": "Delivery address city", "maximum": 250 }, "DeliveryState": { "type": "string", "description": "Delivery address state", "maximum": 250 }, "DeliveryPostalCode": { "type": "string", "description": "Delivery address postcode", "maximum": 250 }, "DeliveryCountry": { "type": "string", "description": "Delivery address country", "maximum": 250 }, "BillingFirstName": { "type": "string", "description": "​Billing recipient first name", "maximum": 250 }, "BillingLastName": { "type": "string", "description": "​Billing recipient last name", "maximum": 250 }, "BillingCompany": { "type": "string", "description": "The billing company name", "maximum": 250 }, "BillingAddress1": { "type": "string", "description": "​Billing address 1", "maximum": 250 }, "BillingAddress2": { "type": "string", "description": "​Billing address 2", "maximum": 250 }, "BillingCity": { "type": "string", "description": "​Billing address city", "maximum": 250 }, "BillingPostalCode": { "type": "string", "description": "​Billing address postcode", "maximum": 250 }, "BillingState": { "type": "string", "description": "Billing address state", "maximum": 250 }, "BillingCountry": { "type": "string", "description": "Billing address country", "maximum": 250 }, "BranchId": { "type": "integer", "description": "Branch Id. Not updatable if SO Dispatched or PO Received. Defaults to \"Main Branch\" ID when omitted." }, "BranchEmail": { "type": "string", "description": "Branch email", "maximum": 250 }, "ProjectName": { "type": "string", "description": "Project Name" }, "TrackingCode": { "type": "string", "description": "Shipping tracking code", "maximum": 50 }, "InternalComments": { "type": "string", "description": "Internal comment" }, "ProductTotal": { "type": "number", "description": "Product Total Only" }, "FreightTotal": { "type": "number", "description": "Total cost of delivery charges" }, "FreightDescription": { "type": "string", "description": "Freight/​carrier description" }, "Surcharge": { "type": "number", "description": "Surcharge" }, "SurchargeDescription": { "type": "string", "description": "Surcharge description" }, "DiscountTotal": { "type": "number", "description": "Total overall discount" }, "DiscountDescription": { "type": "string", "description": "The discount description" }, "Total": { "type": "number", "description": "Order total includes Product Total, Freight Total, Discount Total, Surcharge Total, and Tax" }, "CurrencyCode": { "type": "string", "description": "The three-character ISO currency code e.g. NZD. Omit to use account default." }, "CurrencyRate": { "type": "number", "description": "The currency rate. ​​If no rate is specified (i.e. zero or null), Cin7 will lookup the currency rate from the start of the day as provided by our 3rd party currency service." }, "CurrencySymbol": { "type": "string", "description": "The currency symbol e.g. $. This field is automatically populate based on currency code." }, "TaxStatus": { "type": "string", "description": "Tax Status: Incl, Excl, Exempt. Omit to use account default.", "enum": [ "Undefined", "Incl", "Excl", "Exempt" ] }, "TaxRate": { "type": "number", "description": "Tax Rate e.g. 15. If different from your default tax rate you will need to set the CostCenter or Alternative tax rate field as well.", "minimum": 0.0, "maximum": 100.0 }, "Source": { "type": "string", "description": "The source of the Transaction. This field is read-only." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } }, "required": [ "SalesReference" ] } }, "example": [ { "id": 8, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" } }, { "id": 8, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 9, "processedBy": 10, "isApproved": true, "reference": "sample string 12", "memberId": 13, "firstName": "sample string 14", "lastName": "sample string 15", "company": "sample string 16", "email": "sample string 17", "phone": "sample string 18", "mobile": "sample string 19", "fax": "sample string 20", "deliveryFirstName": "sample string 21", "deliveryLastName": "sample string 22", "deliveryCompany": "sample string 23", "deliveryAddress1": "sample string 24", "deliveryAddress2": "sample string 25", "deliveryCity": "sample string 26", "deliveryState": "sample string 27", "deliveryPostalCode": "sample string 28", "deliveryCountry": "sample string 29", "billingFirstName": "sample string 30", "billingLastName": "sample string 31", "billingCompany": "sample string 32", "billingAddress1": "sample string 33", "billingAddress2": "sample string 34", "billingCity": "sample string 35", "billingPostalCode": "sample string 36", "billingState": "sample string 37", "billingCountry": "sample string 38", "branchId": 39, "branchEmail": "sample string 40", "projectName": "sample string 41", "trackingCode": "sample string 42", "internalComments": "sample string 43", "productTotal": 44.0, "freightTotal": 1.0, "freightDescription": "sample string 45", "surcharge": 1.0, "surchargeDescription": "sample string 46", "discountTotal": 1.0, "discountDescription": "sample string 47", "total": 48.0, "currencyCode": "sample string 50", "currencyRate": 51.0, "currencySymbol": "sample string 52", "taxStatus": "Undefined", "taxRate": 53.0, "source": "sample string 54", "customFields": { "sample string 1": {}, "sample string 3": {} }, "memberEmail": "sample string 1", "modifiedCOGSDate": "2026-04-20T05:47:08Z", "status": "DRAFT", "salesReference": "sample string 2", "creditNoteNumber": 3, "creditNoteDate": "2026-04-20T05:47:08Z", "completedDate": "2026-04-20T05:47:08Z", "customerReport": "sample string 4", "alternativeAccountCode": "sample string 5", "salesPersonId": 6, "logisticsCarrier": "sample string 7", "logisticsStatus": 1, "lineItems": [ { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" }, { "id": 9, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 11, "parentId": 1, "productId": 12, "productOptionId": 13, "integrationRef": "sample string 14", "sort": 15, "code": "sample string 16", "name": "sample string 17", "option1": "sample string 18", "option2": "sample string 19", "option3": "sample string 20", "qty": 1.0, "styleCode": "sample string 1", "barcode": "sample string 2", "sizeCodes": "sample string 4", "lineComments": "sample string 5", "unitCost": 1.0, "unitPrice": 1.0, "discount": 6.0, "qtyShipped": 7.0, "accountCode": "sample string 8" } ], "accountingAttributes": { "importDate": "2026-04-20T05:47:08Z", "accountingImportStatus": "NotImported" } } ] } } } } }, "/api/v1/Payments/{id}": { "get": { "operationId": "GET-Payments-id", "summary": "Get a Payment.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 payment Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "PaymentDate": { "type": "string", "description": "Payment Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "Amount": { "type": "number", "description": "Payment Amount" }, "Method": { "type": "string", "description": "Payment Method" }, "IsAuthorized": { "type": "boolean", "description": "Transaction Authorized" }, "TransactionRef": { "type": "string", "description": "Transaction reference e.g. payment gateway transaction Id or ref", "maximum": 50 }, "Comments": { "type": "string", "description": "Comments", "maximum": 250 }, "OrderId": { "type": "integer", "description": "The unique Cin7 sales order or purchase order Id." }, "OrderRef": { "type": "string", "description": "A unique sales order or purchase order reference. (Read-only)", "maximum": 30 }, "PaymentImportedRef": { "type": "string", "description": "Payment imported ref" }, "BatchReference": { "type": "string", "description": "Batch Reference (Read-only)" }, "ReconcileDate": { "type": "string", "description": "Reconcile date", "format": "date-time" }, "BranchId": { "type": "integer", "description": "Branch Id." }, "OrderType": { "type": "string", "description": "Order Type.", "enum": [ "Undefined", "GenericOrder", "SalesOrder", "PreOrder", "ProductionJob", "PurchaseOrder", "PurchaseQuote", "Quote", "Adjustment", "BatchOrSplitInvoice", "BinLocationTransfer", "BranchTransfer", "SupplierConsignment", "Consignment", "CreditNote", "SupplierCreditNote", "Layby", "BomMaster", "SalesOrdersWithCartons" ] } } }, "example": { "id": 1, "createdDate": "2026-04-17T15:23:23Z", "modifiedDate": null, "paymentDate": "2026-04-17T15:23:23Z", "amount": 196.1, "method": "Credit Card", "isAuthorized": true, "transactionRef": "PAYMENT-GATEWAY-REF", "comments": "Comment...", "orderId": 128, "orderRef": "SALE4-28", "paymentImportedRef": "INTEGRATION-REF", "batchReference": null, "reconcileDate": "2026-04-19T03:23:23Z", "branchId": 0, "orderType": "Undefined" } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Payments" ], "security": [ { "basicAuth": [] } ] }, "delete": { "operationId": "DELETE-Payments-id", "summary": "Delete a Payment.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } }, "example": { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "The payment record Id", "required": true, "schema": { "type": "integer", "description": "The payment record Id" } } ], "tags": [ "Payments" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Payments": { "get": { "operationId": "GET-Payments-fields_where_order_page_rows", "summary": "Get a Payment.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 payment Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "PaymentDate": { "type": "string", "description": "Payment Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "Amount": { "type": "number", "description": "Payment Amount" }, "Method": { "type": "string", "description": "Payment Method" }, "IsAuthorized": { "type": "boolean", "description": "Transaction Authorized" }, "TransactionRef": { "type": "string", "description": "Transaction reference e.g. payment gateway transaction Id or ref", "maximum": 50 }, "Comments": { "type": "string", "description": "Comments", "maximum": 250 }, "OrderId": { "type": "integer", "description": "The unique Cin7 sales order or purchase order Id." }, "OrderRef": { "type": "string", "description": "A unique sales order or purchase order reference. (Read-only)", "maximum": 30 }, "PaymentImportedRef": { "type": "string", "description": "Payment imported ref" }, "BatchReference": { "type": "string", "description": "Batch Reference (Read-only)" }, "ReconcileDate": { "type": "string", "description": "Reconcile date", "format": "date-time" }, "BranchId": { "type": "integer", "description": "Branch Id." }, "OrderType": { "type": "string", "description": "Order Type.", "enum": [ "Undefined", "GenericOrder", "SalesOrder", "PreOrder", "ProductionJob", "PurchaseOrder", "PurchaseQuote", "Quote", "Adjustment", "BatchOrSplitInvoice", "BinLocationTransfer", "BranchTransfer", "SupplierConsignment", "Consignment", "CreditNote", "SupplierCreditNote", "Layby", "BomMaster", "SalesOrdersWithCartons" ] } } } }, "example": [ { "id": 1, "createdDate": "2026-04-17T15:23:23Z", "modifiedDate": null, "paymentDate": "2026-04-17T15:23:23Z", "amount": 196.1, "method": "Credit Card", "isAuthorized": true, "transactionRef": "PAYMENT-GATEWAY-REF", "comments": "Comment...", "orderId": 128, "orderRef": "SALE4-28", "paymentImportedRef": "INTEGRATION-REF", "batchReference": null, "reconcileDate": "2026-04-19T03:23:23Z", "branchId": 0, "orderType": "Undefined" } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Payments" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Payments-", "summary": "Create a list of Payments.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Payments" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 payment Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "PaymentDate": { "type": "string", "description": "Payment Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "Amount": { "type": "number", "description": "Payment Amount" }, "Method": { "type": "string", "description": "Payment Method" }, "IsAuthorized": { "type": "boolean", "description": "Transaction Authorized" }, "TransactionRef": { "type": "string", "description": "Transaction reference e.g. payment gateway transaction Id or ref", "maximum": 50 }, "Comments": { "type": "string", "description": "Comments", "maximum": 250 }, "OrderId": { "type": "integer", "description": "The unique Cin7 sales order or purchase order Id." }, "OrderRef": { "type": "string", "description": "A unique sales order or purchase order reference. (Read-only)", "maximum": 30 }, "PaymentImportedRef": { "type": "string", "description": "Payment imported ref" }, "BatchReference": { "type": "string", "description": "Batch Reference (Read-only)" }, "ReconcileDate": { "type": "string", "description": "Reconcile date", "format": "date-time" }, "BranchId": { "type": "integer", "description": "Branch Id." }, "OrderType": { "type": "string", "description": "Order Type.", "enum": [ "Undefined", "GenericOrder", "SalesOrder", "PreOrder", "ProductionJob", "PurchaseOrder", "PurchaseQuote", "Quote", "Adjustment", "BatchOrSplitInvoice", "BinLocationTransfer", "BranchTransfer", "SupplierConsignment", "Consignment", "CreditNote", "SupplierCreditNote", "Layby", "BomMaster", "SalesOrdersWithCartons" ] } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "paymentDate": "2026-04-20T05:47:08Z", "amount": 1.0, "method": "sample string 2", "isAuthorized": true, "transactionRef": "sample string 5", "comments": "sample string 6", "orderId": 7, "orderRef": "sample string 8", "paymentImportedRef": "sample string 9", "batchReference": "sample string 10", "reconcileDate": "2026-04-20T05:47:08Z", "branchId": 11, "orderType": "Undefined" }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "paymentDate": "2026-04-20T05:47:08Z", "amount": 1.0, "method": "sample string 2", "isAuthorized": true, "transactionRef": "sample string 5", "comments": "sample string 6", "orderId": 7, "orderRef": "sample string 8", "paymentImportedRef": "sample string 9", "batchReference": "sample string 10", "reconcileDate": "2026-04-20T05:47:08Z", "branchId": 11, "orderType": "Undefined" } ] } } } }, "put": { "operationId": "PUT-Payments-", "summary": "Update a Payments.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Payments" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 payment Id." }, "CreatedDate": { "type": "string", "description": "Created Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "PaymentDate": { "type": "string", "description": "Payment Date UTC: yyyy-MM-dd HH:mm:ss", "format": "date-time" }, "Amount": { "type": "number", "description": "Payment Amount" }, "Method": { "type": "string", "description": "Payment Method" }, "IsAuthorized": { "type": "boolean", "description": "Transaction Authorized" }, "TransactionRef": { "type": "string", "description": "Transaction reference e.g. payment gateway transaction Id or ref", "maximum": 50 }, "Comments": { "type": "string", "description": "Comments", "maximum": 250 }, "OrderId": { "type": "integer", "description": "The unique Cin7 sales order or purchase order Id." }, "OrderRef": { "type": "string", "description": "A unique sales order or purchase order reference. (Read-only)", "maximum": 30 }, "PaymentImportedRef": { "type": "string", "description": "Payment imported ref" }, "BatchReference": { "type": "string", "description": "Batch Reference (Read-only)" }, "ReconcileDate": { "type": "string", "description": "Reconcile date", "format": "date-time" }, "BranchId": { "type": "integer", "description": "Branch Id." }, "OrderType": { "type": "string", "description": "Order Type.", "enum": [ "Undefined", "GenericOrder", "SalesOrder", "PreOrder", "ProductionJob", "PurchaseOrder", "PurchaseQuote", "Quote", "Adjustment", "BatchOrSplitInvoice", "BinLocationTransfer", "BranchTransfer", "SupplierConsignment", "Consignment", "CreditNote", "SupplierCreditNote", "Layby", "BomMaster", "SalesOrdersWithCartons" ] } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "paymentDate": "2026-04-20T05:47:08Z", "amount": 1.0, "method": "sample string 2", "isAuthorized": true, "transactionRef": "sample string 5", "comments": "sample string 6", "orderId": 7, "orderRef": "sample string 8", "paymentImportedRef": "sample string 9", "batchReference": "sample string 10", "reconcileDate": "2026-04-20T05:47:08Z", "branchId": 11, "orderType": "Undefined" }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "paymentDate": "2026-04-20T05:47:08Z", "amount": 1.0, "method": "sample string 2", "isAuthorized": true, "transactionRef": "sample string 5", "comments": "sample string 6", "orderId": 7, "orderRef": "sample string 8", "paymentImportedRef": "sample string 9", "batchReference": "sample string 10", "reconcileDate": "2026-04-20T05:47:08Z", "branchId": 11, "orderType": "Undefined" } ] } } } } }, "/api/v1/Branches/{id}": { "get": { "operationId": "GET-Branches-id", "summary": "Get a Branch.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "BranchType": { "type": "string", "description": "Branch Type", "maximum": 250 }, "StockControlOptions": { "type": "string", "description": "Stock control options." }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "AccountNumber": { "type": "string", "description": null }, "BranchLocations": { "type": "array", "description": "Branch Locations.", "items": { "type": "object", "properties": { "Zone": { "type": "string", "description": null }, "Bins": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } } }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Branch 1", "firstName": "J", "lastName": "D", "jobTitle": "Manager", "email": "j@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": null, "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null } ], "branchType": null, "stockControlOptions": null, "taxStatus": null, "accountNumber": null, "branchLocations": [ { "zone": "Location 1", "bins": [ "Bin1", "Bin2" ] }, { "zone": "Location 2", "bins": [ "Bin1", "Bin2", "Bin3" ] } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Branches" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Branches": { "get": { "operationId": "GET-Branches-fields_where_order_page_rows", "summary": "Get a Branch.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "BranchType": { "type": "string", "description": "Branch Type", "maximum": 250 }, "StockControlOptions": { "type": "string", "description": "Stock control options." }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "AccountNumber": { "type": "string", "description": null }, "BranchLocations": { "type": "array", "description": "Branch Locations.", "items": { "type": "object", "properties": { "Zone": { "type": "string", "description": null }, "Bins": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "isActive": true, "company": "Branch 1", "firstName": "J", "lastName": "D", "jobTitle": "Manager", "email": "j@acmecorpation.com", "website": "www.acmecorpation.com", "phone": "(000) 123-4567", "fax": "(000) 123-4567", "mobile": "(000) 123-4567", "address1": "1600 Amphitheatre Pkwy", "address2": null, "city": "Mountain View", "state": "CA", "postCode": "94043", "country": "USA", "postalAddress1": "Postal Address Line 1", "postalAddress2": "Postal Address Line 2", "postalCity": "Postal City", "postalPostCode": "Postal Code", "postalState": "State", "postalCountry": "Country", "notes": "Sample client contact.", "integrationRef": "MY-INTEGRATION-REF", "customFields": null, "secondaryContacts": [ { "id": 1, "company": null, "firstName": "Bob", "lastName": "Joans", "jobTitle": "Freelance Consultant", "email": "bob@acmecorpation.com", "mobile": null, "phone": null } ], "branchType": null, "stockControlOptions": null, "taxStatus": null, "accountNumber": null, "branchLocations": [ { "zone": "Location 1", "bins": [ "Bin1", "Bin2" ] }, { "zone": "Location 2", "bins": [ "Bin1", "Bin2", "Bin3" ] } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "Filter by an any element", "required": false, "schema": { "type": "string", "description": "Filter by an any element" } }, { "name": "order", "in": "query", "description": "Order by any element returned", "required": false, "schema": { "type": "string", "description": "Order by any element returned" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Branches" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Branches-", "summary": "Create a list of Branches.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Branches" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "BranchType": { "type": "string", "description": "Branch Type", "maximum": 250 }, "StockControlOptions": { "type": "string", "description": "Stock control options." }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "AccountNumber": { "type": "string", "description": null }, "BranchLocations": { "type": "array", "description": "Branch Locations.", "items": { "type": "object", "properties": { "Zone": { "type": "string", "description": null }, "Bins": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } } } }, "example": [ { "id": 5, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "isActive": true, "company": "sample string 9", "firstName": "sample string 10", "lastName": "sample string 11", "jobTitle": "sample string 12", "email": "sample string 13", "website": "sample string 14", "phone": "sample string 15", "fax": "sample string 16", "mobile": "sample string 17", "address1": "sample string 18", "address2": "sample string 19", "city": "sample string 20", "state": "sample string 21", "postCode": "sample string 22", "country": "sample string 23", "postalAddress1": "sample string 24", "postalAddress2": "sample string 25", "postalCity": "sample string 26", "postalPostCode": "sample string 27", "postalState": "sample string 28", "postalCountry": "sample string 29", "notes": "sample string 30", "integrationRef": "sample string 31", "customFields": { "sample string 1": {}, "sample string 3": {} }, "secondaryContacts": [ { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" }, { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" } ], "branchType": "sample string 1", "stockControlOptions": "sample string 2", "taxStatus": "sample string 3", "accountNumber": "sample string 4", "branchLocations": null }, { "id": 5, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "isActive": true, "company": "sample string 9", "firstName": "sample string 10", "lastName": "sample string 11", "jobTitle": "sample string 12", "email": "sample string 13", "website": "sample string 14", "phone": "sample string 15", "fax": "sample string 16", "mobile": "sample string 17", "address1": "sample string 18", "address2": "sample string 19", "city": "sample string 20", "state": "sample string 21", "postCode": "sample string 22", "country": "sample string 23", "postalAddress1": "sample string 24", "postalAddress2": "sample string 25", "postalCity": "sample string 26", "postalPostCode": "sample string 27", "postalState": "sample string 28", "postalCountry": "sample string 29", "notes": "sample string 30", "integrationRef": "sample string 31", "customFields": { "sample string 1": {}, "sample string 3": {} }, "secondaryContacts": [ { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" }, { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" } ], "branchType": "sample string 1", "stockControlOptions": "sample string 2", "taxStatus": "sample string 3", "accountNumber": "sample string 4", "branchLocations": null } ] } } } }, "put": { "operationId": "PUT-Branches-", "summary": "Update a list of Branches.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Branches" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "BranchType": { "type": "string", "description": "Branch Type", "maximum": 250 }, "StockControlOptions": { "type": "string", "description": "Stock control options." }, "TaxStatus": { "type": "string", "description": "Tax Status" }, "AccountNumber": { "type": "string", "description": null }, "BranchLocations": { "type": "array", "description": "Branch Locations.", "items": { "type": "object", "properties": { "Zone": { "type": "string", "description": null }, "Bins": { "type": "array", "description": null, "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Created Date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Modified Date", "format": "date-time" }, "IsActive": { "type": "boolean", "description": "Is Active" }, "Company": { "type": "string", "description": "Company", "maximum": 250 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 250 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 250 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 250 }, "Email": { "type": "string", "description": "A unique email address" }, "Website": { "type": "string", "description": "Website", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 }, "Fax": { "type": "string", "description": "Fax", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Address1": { "type": "string", "description": "Address 1", "maximum": 50 }, "Address2": { "type": "string", "description": "Address 2", "maximum": 50 }, "City": { "type": "string", "description": "City", "maximum": 50 }, "State": { "type": "string", "description": "State", "maximum": 50 }, "PostCode": { "type": "string", "description": "Post Code", "maximum": 50 }, "Country": { "type": "string", "description": "Country", "maximum": 50 }, "PostalAddress1": { "type": "string", "description": "Billing/Postal Address 1", "maximum": 50 }, "PostalAddress2": { "type": "string", "description": "Billing/Postal Address 2", "maximum": 50 }, "PostalCity": { "type": "string", "description": "Billing/Postal City", "maximum": 50 }, "PostalPostCode": { "type": "string", "description": "Billing/Postal Post Code", "maximum": 50 }, "PostalState": { "type": "string", "description": "Billing/Postal State", "maximum": 50 }, "PostalCountry": { "type": "string", "description": "Billing/Postal Country", "maximum": 50 }, "Notes": { "type": "string", "description": "Notes", "maximum": 250 }, "IntegrationRef": { "type": "string", "description": "Integration reference." }, "CustomFields": { "type": "array", "description": "Custom fields.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } }, "SecondaryContacts": { "type": "array", "description": "Secondary Contacts", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Company": { "type": "string", "description": "Company", "maximum": 150 }, "FirstName": { "type": "string", "description": "First Name", "maximum": 50 }, "LastName": { "type": "string", "description": "Last Name", "maximum": 50 }, "JobTitle": { "type": "string", "description": "Job Title", "maximum": 50 }, "Email": { "type": "string", "description": "Email", "maximum": 50 }, "Mobile": { "type": "string", "description": "Mobile", "maximum": 50 }, "Phone": { "type": "string", "description": "Phone", "maximum": 50 } }, "required": [ "FirstName", "Email" ] } } } } }, "example": [ { "id": 5, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "isActive": true, "company": "sample string 9", "firstName": "sample string 10", "lastName": "sample string 11", "jobTitle": "sample string 12", "email": "sample string 13", "website": "sample string 14", "phone": "sample string 15", "fax": "sample string 16", "mobile": "sample string 17", "address1": "sample string 18", "address2": "sample string 19", "city": "sample string 20", "state": "sample string 21", "postCode": "sample string 22", "country": "sample string 23", "postalAddress1": "sample string 24", "postalAddress2": "sample string 25", "postalCity": "sample string 26", "postalPostCode": "sample string 27", "postalState": "sample string 28", "postalCountry": "sample string 29", "notes": "sample string 30", "integrationRef": "sample string 31", "customFields": { "sample string 1": {}, "sample string 3": {} }, "secondaryContacts": [ { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" }, { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" } ], "branchType": "sample string 1", "stockControlOptions": "sample string 2", "taxStatus": "sample string 3", "accountNumber": "sample string 4", "branchLocations": null }, { "id": 5, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "isActive": true, "company": "sample string 9", "firstName": "sample string 10", "lastName": "sample string 11", "jobTitle": "sample string 12", "email": "sample string 13", "website": "sample string 14", "phone": "sample string 15", "fax": "sample string 16", "mobile": "sample string 17", "address1": "sample string 18", "address2": "sample string 19", "city": "sample string 20", "state": "sample string 21", "postCode": "sample string 22", "country": "sample string 23", "postalAddress1": "sample string 24", "postalAddress2": "sample string 25", "postalCity": "sample string 26", "postalPostCode": "sample string 27", "postalState": "sample string 28", "postalCountry": "sample string 29", "notes": "sample string 30", "integrationRef": "sample string 31", "customFields": { "sample string 1": {}, "sample string 3": {} }, "secondaryContacts": [ { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" }, { "id": 1, "company": "sample string 2", "firstName": "sample string 3", "lastName": "sample string 4", "jobTitle": "sample string 5", "email": "sample string 6", "mobile": "sample string 7", "phone": "sample string 8" } ], "branchType": "sample string 1", "stockControlOptions": "sample string 2", "taxStatus": "sample string 3", "accountNumber": "sample string 4", "branchLocations": null } ] } } } } }, "/api/v1/Adjustments/{id}": { "get": { "operationId": "GET-Adjustments-id", "summary": "Get an Adjustment.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 20 }, "BranchId": { "type": "integer", "description": "Branch ID." }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "AdjustInAccountingSystem": { "type": "string", "description": "Date to adjust in Accounting system.", "format": "date-time" }, "AdjustmentReason": { "type": "string", "description": "The reason for adjusting Stock." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account." }, "ProductTotal": { "type": "number", "description": "Product Total." }, "Source": { "type": "string", "description": "The source of the Transaction." }, "LineItems": { "type": "array", "description": "Line Items.", "items": { "type": "object", "properties": { "QtyAdjusted": { "type": "number", "description": "Quantity Adjusted." }, "HoldingQty": { "type": "number", "description": "Holding Quantity." }, "Account": { "type": "string", "description": "GL Account Code." }, "UnitCost": { "type": "number", "description": "Unit Cost." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } }, "example": { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "ADJ-1", "branchId": 3, "completedDate": "2026-04-19T00:00:00Z", "adjustInAccountingSystem": null, "adjustmentReason": null, "alternativeAccountCode": null, "productTotal": 0.0, "source": "API", "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": null, "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "qtyAdjusted": null, "holdingQty": null, "account": null, "unitCost": null } ] } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "Adjustments" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/Adjustments": { "get": { "operationId": "GET-Adjustments-fields_where_order_page_rows", "summary": "Get an Adjustment.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 20 }, "BranchId": { "type": "integer", "description": "Branch ID." }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "AdjustInAccountingSystem": { "type": "string", "description": "Date to adjust in Accounting system.", "format": "date-time" }, "AdjustmentReason": { "type": "string", "description": "The reason for adjusting Stock." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account." }, "ProductTotal": { "type": "number", "description": "Product Total." }, "Source": { "type": "string", "description": "The source of the Transaction." }, "LineItems": { "type": "array", "description": "Line Items.", "items": { "type": "object", "properties": { "QtyAdjusted": { "type": "number", "description": "Quantity Adjusted." }, "HoldingQty": { "type": "number", "description": "Holding Quantity." }, "Account": { "type": "string", "description": "GL Account Code." }, "UnitCost": { "type": "number", "description": "Unit Cost." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "modifiedDate": "2026-04-18T15:23:23Z", "createdBy": 0, "processedBy": 0, "isApproved": false, "reference": "ADJ-1", "branchId": 3, "completedDate": "2026-04-19T00:00:00Z", "adjustInAccountingSystem": null, "adjustmentReason": null, "alternativeAccountCode": null, "productTotal": 0.0, "source": "API", "lineItems": [ { "id": 1, "createdDate": "2026-04-18T15:23:23Z", "transactionId": 128, "parentId": 0, "productId": 1, "productOptionId": 1, "integrationRef": null, "sort": 1, "code": "", "name": "V-NECK TSHIRT", "option1": "Red", "option2": "XXL", "option3": "Yes", "qty": 2.0, "qtyAdjusted": null, "holdingQty": null, "account": null, "unitCost": null } ] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "Adjustments" ], "security": [ { "basicAuth": [] } ] }, "post": { "operationId": "POST-Adjustments-", "summary": "Create a list of Adjustments.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Adjustments" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 20 }, "BranchId": { "type": "integer", "description": "Branch ID." }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "AdjustInAccountingSystem": { "type": "string", "description": "Date to adjust in Accounting system.", "format": "date-time" }, "AdjustmentReason": { "type": "string", "description": "The reason for adjusting Stock." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account." }, "ProductTotal": { "type": "number", "description": "Product Total." }, "Source": { "type": "string", "description": "The source of the Transaction." }, "LineItems": { "type": "array", "description": "Line Items.", "items": { "type": "object", "properties": { "QtyAdjusted": { "type": "number", "description": "Quantity Adjusted." }, "HoldingQty": { "type": "number", "description": "Holding Quantity." }, "Account": { "type": "string", "description": "GL Account Code." }, "UnitCost": { "type": "number", "description": "Unit Cost." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "processedBy": 4, "isApproved": true, "reference": "sample string 5", "branchId": 6, "completedDate": "2026-04-20T05:47:08Z", "adjustInAccountingSystem": "2026-04-20T05:47:08Z", "adjustmentReason": "sample string 7", "alternativeAccountCode": "sample string 8", "productTotal": 9.0, "source": "sample string 10", "lineItems": [ { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 }, { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "processedBy": 4, "isApproved": true, "reference": "sample string 5", "branchId": 6, "completedDate": "2026-04-20T05:47:08Z", "adjustInAccountingSystem": "2026-04-20T05:47:08Z", "adjustmentReason": "sample string 7", "alternativeAccountCode": "sample string 8", "productTotal": 9.0, "source": "sample string 10", "lineItems": [ { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 }, { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 } ] } ] } } } }, "put": { "operationId": "PUT-Adjustments-", "summary": "Update a list of Adjustments.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Index": { "type": "integer", "description": "​The index at which the record was positioned in an insert or update." }, "Success": { "type": "boolean", "description": "​True if the record was successfully inserted or updated." }, "Id": { "type": "integer", "description": "The record Id." }, "Code": { "type": "string", "description": "The record code." }, "Errors": { "type": "array", "description": "A list of errors if the insert or update fails.", "items": { "type": "string", "properties": { "Chars": { "type": "object", "description": null }, "Length": { "type": "integer", "description": null } } } } } } }, "example": [ { "index": 0, "success": true, "id": 1, "code": "SALE4-28", "errors": [] }, { "index": 1, "success": true, "id": 2, "code": "SALE5-29", "errors": [] } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [], "tags": [ "Adjustments" ], "security": [ { "basicAuth": [] } ], "requestBody": { "description": "", "required": true, "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "CreatedDate": { "type": "string", "description": "Order created date", "format": "date-time" }, "ModifiedDate": { "type": "string", "description": "Order last modified date", "format": "date-time" }, "CreatedBy": { "type": "integer", "description": "The ID for the User who created the Transaction." }, "ProcessedBy": { "type": "integer", "description": "The ID for the User who processed the Transaction." }, "IsApproved": { "type": "boolean", "description": "Is Approved (default: true)" }, "Reference": { "type": "string", "description": "A unique order reference (leave blank to auto-generate in an insert).", "maximum": 20 }, "BranchId": { "type": "integer", "description": "Branch ID." }, "CompletedDate": { "type": "string", "description": "Completed Date.", "format": "date-time" }, "AdjustInAccountingSystem": { "type": "string", "description": "Date to adjust in Accounting system.", "format": "date-time" }, "AdjustmentReason": { "type": "string", "description": "The reason for adjusting Stock." }, "AlternativeAccountCode": { "type": "string", "description": "Alternative GL Account." }, "ProductTotal": { "type": "number", "description": "Product Total." }, "Source": { "type": "string", "description": "The source of the Transaction." }, "LineItems": { "type": "array", "description": "Line Items.", "items": { "type": "object", "properties": { "QtyAdjusted": { "type": "number", "description": "Quantity Adjusted." }, "HoldingQty": { "type": "number", "description": "Holding Quantity." }, "Account": { "type": "string", "description": "GL Account Code." }, "UnitCost": { "type": "number", "description": "Unit Cost." }, "Id": { "type": "integer", "description": "The unique Cin7 ID" }, "CreatedDate": { "type": "string", "description": "Created date", "format": "date-time" }, "TransactionId": { "type": "integer", "description": "Transaction ID e.g. Sales Order Id, Quote Id or Purchase Order Id" }, "ParentId": { "type": "integer", "description": "Parent Line Item ID (Read-only)" }, "ProductId": { "type": "integer", "description": "Product ID (Read-only)" }, "ProductOptionId": { "type": "integer", "description": "The product option ID (Optional); ProductOptionId or Code should be specified to link a product to the line item." }, "IntegrationRef": { "type": "string", "description": "Integration reference" }, "Sort": { "type": "integer", "description": "Sort (or sequence) of line items" }, "Code": { "type": "string", "description": null }, "Name": { "type": "string", "description": "Item name" }, "Option1": { "type": "string", "description": "Option 1" }, "Option2": { "type": "string", "description": "Option 2" }, "Option3": { "type": "string", "description": "Option 3" }, "Qty": { "type": "number", "description": "Quantity" } } } } } } }, "example": [ { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "processedBy": 4, "isApproved": true, "reference": "sample string 5", "branchId": 6, "completedDate": "2026-04-20T05:47:08Z", "adjustInAccountingSystem": "2026-04-20T05:47:08Z", "adjustmentReason": "sample string 7", "alternativeAccountCode": "sample string 8", "productTotal": 9.0, "source": "sample string 10", "lineItems": [ { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 }, { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 } ] }, { "id": 1, "createdDate": "2026-04-20T05:47:08Z", "modifiedDate": "2026-04-20T05:47:08Z", "createdBy": 3, "processedBy": 4, "isApproved": true, "reference": "sample string 5", "branchId": 6, "completedDate": "2026-04-20T05:47:08Z", "adjustInAccountingSystem": "2026-04-20T05:47:08Z", "adjustmentReason": "sample string 7", "alternativeAccountCode": "sample string 8", "productTotal": 9.0, "source": "sample string 10", "lineItems": [ { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 }, { "id": 2, "createdDate": "2026-04-20T05:47:08Z", "transactionId": 4, "parentId": 1, "productId": 5, "productOptionId": 6, "integrationRef": "sample string 7", "sort": 8, "code": "sample string 9", "name": "sample string 10", "option1": "sample string 11", "option2": "sample string 12", "option3": "sample string 13", "qty": 1.0, "qtyAdjusted": 1.0, "holdingQty": 1.0, "account": "sample string 1", "unitCost": 1.0 } ] } ] } } } } }, "/api/v1/SerialNumbers/{id}": { "get": { "operationId": "GET-SerialNumbers-id", "summary": "Get a Serial Number.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Serialnumber": { "type": "string", "description": "Serial number" }, "ProductId": { "type": "integer", "description": "The unique Cin7 product Id." }, "ProductOptionId": { "type": "integer", "description": "The unique product option Id." }, "LineItemId": { "type": "integer", "description": "The ID for the respective line item." }, "Code": { "type": "string", "description": "The unique Cin7 price option code." }, "HoldingGroup": { "type": "string", "description": "Holding Group" }, "BranchId": { "type": "integer", "description": "The unique Cin7 member Id of the branch." }, "Available": { "type": "number", "description": "Available" } } }, "example": { "id": 1, "serialnumber": "BARCODE-FOR-BLUE-T", "productId": 1, "productOptionId": 0, "lineItemId": 0, "code": "SKU-BLUE-T", "holdingGroup": "", "branchId": 0, "available": 10.0 } } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "id", "in": "path", "description": "", "required": true, "schema": { "type": "integer", "description": "" } } ], "tags": [ "SerialNumbers" ], "security": [ { "basicAuth": [] } ] } }, "/api/v1/SerialNumbers": { "get": { "operationId": "GET-SerialNumbers-fields_where_order_page_rows", "summary": "Get a Serial Number.", "description": "", "responses": { "200": { "description": "Successful Operation", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "Id": { "type": "integer", "description": "The unique Cin7 Id." }, "Serialnumber": { "type": "string", "description": "Serial number" }, "ProductId": { "type": "integer", "description": "The unique Cin7 product Id." }, "ProductOptionId": { "type": "integer", "description": "The unique product option Id." }, "LineItemId": { "type": "integer", "description": "The ID for the respective line item." }, "Code": { "type": "string", "description": "The unique Cin7 price option code." }, "HoldingGroup": { "type": "string", "description": "Holding Group" }, "BranchId": { "type": "integer", "description": "The unique Cin7 member Id of the branch." }, "Available": { "type": "number", "description": "Available" } } } }, "example": [ { "id": 1, "serialnumber": "BARCODE-FOR-BLUE-T", "productId": 1, "productOptionId": 0, "lineItemId": 0, "code": "SKU-BLUE-T", "holdingGroup": "", "branchId": 0, "available": 10.0 } ] } } }, "400": { "description": "Bad request - Possible messages: The page number is out of range; the value must be greater than or equal to 1., The rows argument cannot be less than 250., The rows argument cannot be greater than 250., Batch limit is 250., Missing or malformed JSON data; please see the documentation for examples., or any other validation error", "content": { "application/json": { "schema": { "type": "string", "enum": [ "The page number is out of range; the value must be greater than or equal to 1.", "The rows argument cannot be less than 250.", "The rows argument cannot be greater than 250.", "Batch limit is 250.", "Missing or malformed JSON data; please see the documentation for examples." ] } } } }, "401": { "description": "Unauthorized - Authentication is required to access this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Unauthorized access" } } } }, "403": { "description": "Forbidden - You do not have access to this resource.", "content": { "application/json": { "schema": { "type": "string", "example": "Access is forbidden" } } } }, "404": { "description": "Not Found - The requested resource was not found.", "content": { "application/json": { "schema": { "type": "string", "example": "Resource not found" } } } }, "429": { "description": "Too Many Requests - You have exceeded the allowed number of requests.", "content": { "application/json": { "schema": { "type": "string", "example": "Rate limit exceeded. Retry after some time." } } } }, "500": { "description": "Internal Server Error - An unexpected error occurred.", "content": { "application/json": { "schema": { "type": "string", "example": "An unexpected error occurred. Please try again later." } } } }, "503": { "description": "Service Unavailable - The server is temporarily unavailable.", "content": { "application/json": { "schema": { "type": "string", "example": "Service temporarily unavailable. Please try again later." } } } } }, "parameters": [ { "name": "fields", "in": "query", "description": "A comma-separated list of field names", "required": false, "schema": { "type": "string", "description": "A comma-separated list of field names" } }, { "name": "where", "in": "query", "description": "A where clause", "required": false, "schema": { "type": "string", "description": "A where clause" } }, { "name": "order", "in": "query", "description": "An order by clause", "required": false, "schema": { "type": "string", "description": "An order by clause" } }, { "name": "page", "in": "query", "description": "The page number (default: 1)", "required": false, "schema": { "type": "integer", "description": "The page number (default: 1)" } }, { "name": "rows", "in": "query", "description": "Rows per page (default: 50, maximum: 250)", "required": false, "schema": { "type": "integer", "description": "Rows per page (default: 50, maximum: 250)" } } ], "tags": [ "SerialNumbers" ], "security": [ { "basicAuth": [] } ] } } }, "components": { "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" } } }, "security": [ { "basicAuth": [] } ] }