MENU

Platform API

Squizz.com contains a data Application Programming Interface (API) that allows 3rd party software to send and receive data from the platform. The Data API allows separate organisation business systems to communicate together through the endpoints that the platform's API provides. The API can be used to automate a number of processes, as well as provide ways for organisations to buy and sell within the platform by providing the data it requires. To use the API you will need to have knowledge in building software applications, and particularly on how to make requests over the internet to RESTful web services, which the platform's API is based on.

Topics

  1. Prerequisites
  2. API Native Programming Language Libraries
  3. Web Service Endpoint: Create Organisation API Session
  4. Web Service Endpoint: Destroy Organisation API Session
  5. Web Service Endpoint: Validate Organisation API Session
  6. Web Service Endpoint: Import Organisation Data
  7. Web Service Endpoint: Retrieve Organisation Data
  8. Web Service Endpoint: Procure And Send Purchase Order To Supplier
  9. Web Service Endpoint: Send Customer Invoice To Customer
  10. Web Service Endpoint: Search Organisation Customer Account Records
  11. Web Service Endpoint: Retrieve Organisation Customer Account Record
  12. Web Service Endpoint: Create Organisation Notification
  13. Web Service Endpoint: Validate Organisation Security Certificate
  14. Outgoing Request: Get Customer Account Enquiry Records
  15. Outgoing Request: Get Customer Account Enquiry Record
  16. Outgoing Request: Get Supplier Account Enquiry Records
  17. Outgoing Request: Get Supplier Account Enquiry Record
  18. Outgoing Request: Post Purchase Order
  19. Outgoing Request: Post Sales Order
  20. Outgoing Request: Post Customer Account Invoice Payment
  21. Outgoing Request: Get Connector Status

API Native Programming Language Libraries

The SQUIZZ.com platform's API allows software to be written that directly sends data through its HTTPS endpoint requests, and receive responses in the JSON data format. This however requires additional code to written to send requests to the platform and parse JSON responses. To reduce the code required to be written, open source API libraries for select selected programming languages has been developed. If a native library exists for your programming language listed below we recommend to use that library instead to make calls direct to the API, since it will save software developers time, and effort to develop the ability to push data into and out of the platform. If your programming language is not on the list below visit the SQUIZZ.com feed to talk about your need in developing a library, or otherwise make direct HTTPS calls to the API in the endpoints as listed in the sections below.

SQUIZZ.com Platform API Java Library

This library allows Java applications to call the API using native Java classes and objects. Visit https://github.com/squizzdotcom/squizz-platform-api-java-library to see examples on how to use the library within your Java application, as well as make contributions to the open source library.

Download Library

SQUIZZ.com Platform API PHP Library

This library allows PHP applications to call the API using native PHP classes and objects.
Visit https://github.com/squizzdotcom/squizz-platform-api-php-library to see examples on how to use the library within your PHP application, as well as make contributions to the open source library.

Download Library

SQUIZZ.com Platform API .NET Library

This library allows .NET applications to call the API using native .NET classes and objects.
Visit https://github.com/squizzdotcom/squizz-platform-api-dotnet-library to see examples on how to use the library within your .NET application, as well as make contributions to the open source library.

Download Library

Web Service Endpoint: Create Organisation API Session

The endpoint creates a new session in the API by logging with the credentials of an existing organisation registered in the platform. This endpoint must be called first in order to obtain the session ID that is required for all other organisation endpoints. This endpoint can be also used to only check if an organisation's API credentials given are correct. Ensure that the credentials of the organisation have been setup in the organisation's profile first, which can be set from within the Admin section, within the API Settings dialog.

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/create_session
Headers  
Content-Type application/x-www-form-urlencoded
Body Parameters Data Type Mandatory Description
org_id STRING Yes ID of the organisation issued by squizz.com
api_org_key STRING Yes Key issued to the organisation by squizz.com to access the API
api_org_pw STRING Yes Password set by an organisation's administrator person to allow access to the API
create_session ENUM (Y or N) No If set to N then the credentials will only be verified and the session will not be created.

HTTP Request Raw Example:

POST https://api.squizz.com/rest/1/org/create_session HTTP/1.1
Host: api.squizz.com
Content-Length: 115
Content-Type: application/x-www-form-urlencoded

org_id=039583957203259WER2484832&api_org_key=12345678901234567890&api_org_pw=exmample_api_password&create_session=Y

HTTP Response

Response Data Type JSON
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then a API session was successfully created.
result_code STRING

Status code of trying to import the ESD document data. The following codes could be returned:

  • SERVER_SUCCESS
    The API session was successfully created or credentials validated.
  • SERVER_ERROR_ORG_NOT_FOUND
    An organisation with the given org_id could not be found within the platform. Check that the organisation exists in the platform.
  • SERVER_ERROR_ORG_INACTIVE
    The ID of the organisation given in the request is correct however the organisation is not active on the platform. Only organisations marked as active are allowed to use the API.
  • SERVER_ERROR_INCORRECT_API_CREDENTIALS
    The API credentials given in the request do not match the credentials set up for the organisation. Check that the API Key matches what is set for the organisation, and that a API password has been set for the organisation.
  • SERVER_ERROR_UNKNOWN
    An unspecified error occurred when calling the API. If this error continually occurs then raise a post within the feeds on the SQUIZZ.com platform.
session_id STRING ID of the session if one was successfully created.
api_version STRING Version of the API being used to handle the endpoint request.

 

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS", "session_id":"404534DEFWSFSD3445334534786"}

Web Service Endpoint: Destroy Organisation API Session

The endpoint terminates an existing session in the API by destroying the it based on the session ID given. Once the API has finished being used it is recommended to destroy the session and close off any resources that it was using on the platform. If the session is not destroyed then eventually it will expire and be forcibly terminated by the platform.

HTTP Request

HTTP Method GET
HTTP URL https://api.squizz.com/rest/1/org/destroy_session/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL

HTTP Response

Response Data Type JSON
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then a API session was successfully destroyed.
result_code STRING Status code of trying to destroy the session. See the Appendix I for the list of possible result codes.
api_version STRING Version of the API being used to handle the endpoint request.

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS"}

Web Service Endpoint: Validate Organisation API Session

The endpoint checks to see if an existing session still exists when using the API based on the session ID given. This endpoint can be used to verify an existing session exists before requiring to create a new session, or destroy an existing session.

HTTP Request

HTTP Method GET
HTTP URL https://api.squizz.com/rest/1/org/validate_session/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then a API session was successfully validated.
result_code STRING Status code of trying to validate the session. See the Appendix I for the list of possible result codes.
api_version STRING Version of the API being used to handle the endpoint request.
session_valid ENUM (Y or N) If set to Y then the session is still valid, otherwise N indicates that it has been destroyed.

 

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS", "session_valid":"Y"}

Web Service Endpoint: Import Organisation Data

The endpoint imports different lists of organisation data based on the given data type. The data being imported must be placed into the Body of the HTTP request in the form of a conforming Ecommerce Standards Document JSON string that matches with the data type specified. For example this endpoint can be used to import a list of product records that have been wrapped up within a JSON formatted "Products Ecommerce Standards Document".Before using this endpoint we recommend that you understand what the Ecommerce Standards Documents are and how you can convert business data from your system into the standards. It is highly recommended that any data uploaded using this endpoint be compressed using the GZIP compression algorithm and uploaded in a stream. Note that there are trading token costs to import the organisation data using this API, of which the organisation importing the data must have enough tokens to allow the data to import. See the Trading Tokens and Pricing Help page for data import costs.

Data Import Types

Below is a list of the following types of documents and records that can be imported into the platform, with the data structured in JSON data conforming to the Ecommerce Standards Documents:

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/import_esd/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
import_type_id INTEGER Yes ID of the data type being imported. Set one of the numbers:
Body JSON Yes Body contains a type of Ecommerce Standards Document with one or more records that has been serialized into a JSON data string.

 

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the data was imported into the platform against the organsiation.
result_code STRING Status code of trying to import the ESD document data. See the Appendix I for the list of possible result codes.
api_version STRING Version of the API being used to handle the endpoint request.

 

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS"}

Web Service Endpoint: Retrieve Organisation Data

The endpoint allows different kinds of organisational data to be retrieved from another chosen organisation who had previously imported their data into the platform. The endpoint will return a list of records in a conforming Ecommerce Standards document that will be formatted in a JSON HTTP response. For example the endpoint could be called to get a list of products from a supplying organisation, or get a list of stock quantities for the products that a supplier organisation sells. See the list below of the kinds of data that can be retrieved.

Organisations who are supplying the data can control the kinds data that is available to other organisations through the use of "Data Sharing Policies". For example one organisation may not allow another organisation to retrieve stock quantities, but may allow the retrieving organisation to get product pricing data. Data sharing policies may also be used to restrict the kinds of products that another organisation may retrieve.

The endpoint allows a maximum of 5000 records to be retrieved in one request. Where there are more than 5000 records to retrieve the calling software can use the "records_start_index" and "records_max_amount" parameters to step through and download the a range of records across multiple requests.

Before using this endpoint we recommend that you understand what the Ecommerce Standards Documents are and how you can read data from the standards into your own business logic. Note that there are trading token costs to retrieve the organisation data using this API. These costs may be paid by the organisation supplying the data, or the organisation retrieving the data depending on the data sharing policy that the supplying organisation has set up. See Trading Tokens and Pricing for information on costs.

HTTP Request

HTTP Method GET
HTTP URL https://api.squizz.com/rest/1/org/retrieve_esd/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
supplier_org_id STRING Yes ID of the organisation issued by the platform to retrieve the data from.
data_type_id INTEGER Yes ID of the type of data to retrieve. Set one of the numbers:
records_start_index INTEGER No The index to start retrieving the records from. For example if there are 8000 product records, setting the record_start_index to 2000 will get records numbered 2000 onwards. If the parameter is not set then the start index is set to 0.
records_max_amount INTEGER No Sets the maximum amount of records that are returned. For example if set to 1000 then only up to 1000 records will be returned by the endpoint. If the parameter is not set or the value is higher than 5000 then the parameter will be set to 5000.
customer_account_code STRING Conditional Code of the supplying organisation's customer account. The account code is only required when the "data_type_id" is set to 37 to retrieve Customer Account Product Pricing, and if the supplying organisation has assigned multiple customer accounts to the organisation calling the endpoint. The customer account code will dictate how the products are priced.

 

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the data was successfully retrieved.
resultStatus INTEGER
  • Set to 1 of the data was successfully obtained
  • Set to 2 of the data could not be obtained
version DECIMAL Version of the Ecommerce Standards Document being returned from the server.
configs.api_version DECIMAL Version of the SQUIZZ.com platform's API used to handle the request
configs.result_code STRING

Status code of trying to retrieve the organisation's data. The following codes could be returned:

  • SERVER_SUCCESS
    The record data was successfully obtained.
     
  • SERVER_ERROR_ORG_DOES_NOT_EXIST
    The organisation supplying the data with the given organisation ID could not be found or is not active within the platform. Check with the supplier organisation that their organisation ID issued by the platform is correct.
     
  • SERVER_ERROR_SESSION_INVALID
    The session used to call the endpoint has expired, or never existed. Look at calling the Create Session endpoint to get another session ID.
     
  • SERVER_ERROR_NO_ORG_CUSTOMER_ACCOUNT_SET
    No customer account has been provided when calling the endpoint to obtain pricing data, or the customer account provided does not match the account that the organisation who is supplying the data has assigned.
     
  • SERVER_ERROR_NO_ORG_CUSTOMER_ACCOUNT_ASSIGNED
    The organisation supplying the pricing data has not assigned any customer account to the customer organisation. The supplier organiation needs to do so to allow pricing data to be obtained.
     
  • SERVER_ERROR_ORG_CANNOT_BE_FOUND
    The organisation supplying the data with the given organisation ID could not be found or is not active within the platform or otherwise no connection exists between the two organisations.
     
  • SERVER_ERROR_PERMISSION_DENIED
    The organisation calling the endpoint does not have permission to obtain the kind of data requested from the organisation supplying the data.
     
  • SERVER_ERROR_ORG_NOT_ENOUGH_CREDITS
    Either the organisation supplying the data, or the organisation retrieving the data does not have enough trading tokens within the platform to pay for the data retrieval. Check that either organisation has enough trading tokens to cover retrieving the data.
     
  • SERVER_ERROR_UNKOWN
    An unspecified or unexpected error has occurred on the server when calling the endpoint. If this error continues to be returned please raise the issue with SQUIZZ.com.
configs.recordsStartIndex INTEGER The start index of the record that records were returned from
configs.recordsMaxAmount INTEGER The maximum amount of records that have been returned by the endpoint
configs.dataFields CSV Contains a list of comma separated values containing the fields that are included in the record data being exported. If the field is displayed in this CSV list but the record does not contain the field in the dataRecords array, then it denotes that the record is using the default value of the field.
dataRecords JSON ARRAY

List of records based on the data type set in the request:

  • If the Data Type ID is set to 3 then returns a list of Product Ecommerce Standards Records. Each record contains details of a product.
  • If the Data Type ID is set to 37 then returns a list of Price Ecommerce Standards Records. The pricing records contains both unit and quantity break pricing for each of the products the requesting organisation can buy products at, based on its relationship with the organisation supplying the data.
  • If the Data Type ID is set to 10 then returns a list of Stock Quantity Ecommerce Standards Records. Each stock quantity record defines the amount of product stock that is available by the organisation supplying the stock.

 

HTTP Response Example:

{"result":"SUCCESS", "version":"1.0", "configs":{"dataFields":"comma,list,of,record,fields,being,exported", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS", "recordsStartIndex":"0", "recordsMaxAmount":"5000"}, "dataRecords":[list_of_esd_records]}

Web Service Endpoint: Procure And Send Purchase Order To Supplier

The endpoint is used by a customer organisation to push one or more purchase orders into the platform and have it procured by a designated supplier organisation. "Procure" means for the customer organisation to find and buy goods/services off the supplying organisation. This endpoint allows a customer organisation to automate purchasing off selected supplier organisations registered in the platform. Additionally it helps a supplier organisations to automate selling to existing customer organisations.

Procure and Send Purchase Order to Supplier Platform API Endpoint Diagram

The endpoint will look through each purchase order given to it and try to find matching products that the chosen supplying organisation sells. Once all ordered products have been matched then the endpoint will price each product based on the quantities, relationship and customer account that the supplier organisation has assigned to the customer organisation. Only if all products in the purchase orders have been priced will the endpoint then create one or more sales orders for the supplier organisation and have the sales orders be marked as submitted for processing by the supplier organisation. The endpoint will then return each of the sales orders that were created, allowing the customer organisation to know the costs of the sales order and be able to update the purchase order based on the sales order totals.

Endpoint Requirements

To use this endpoint the following conditions need to be met:

  • The customer organisation needs to be connected to the supplier organisation on the SQUIZZ.com platform.
  • The supplier organisation's Trading Status must be set to Fully Trading or Selling Only.
  • The customer organisation's Trading Status must be set to Fully Trading or Buying Only.
  • The supplier organisation needs to have assigned at least one customer account to the customer organisation
  • The assigned customer account needs to have an "On Account" payment type set, allowing the customer organisation to pay for the ordered products at a later date, based on agreed terms with the supplier organisation.
  • The assigned customer account must be active and allow orders to be created against it (not on hold or outside terms and limits).
  • Every product in the purchase orders must match to the supplying organisation's products based on either of the following:
    • The customer's product code matches supplier's product code
    • The customer's product is assigned to an alternate code that matches the supplier's product code, and the alternate codes have been previously imported into the platform by the customer organisation.
    • The customer's product has previously been mapped to the supplier's product based on a previous order being submitted, either through this endpoint, or by a person using the Order Procurement feature within the platform.
  • The supplier organisation is able to price all matched products in the purchase orders.
  • The supplier organisation has enough trading tokens in the platform for the sales order transaction.

The purchase orders being imported must be placed into the Body of the HTTP request in the form of a conforming Ecommerce Standards Purchase Order Document JSON string. Before using this endpoint we recommend that you understand what the Ecommerce Standards Documents are and how you can convert purchase order data from your system into the standards document. It is highly recommended that any purchase order data uploaded using this endpoint be compressed using the GZIP compression algorithm. Note that there are trading token costs to the supplier organisation to have the sales orders created, of which the supplier organisation must have enough tokens to allow to do. For suppliers see the Trading Tokens and Pricing  page for more details.

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/procure_purchase_order_from_supplier/session_id?supplier_org_id=[org_id]&customer_account_code=[customer_account_code]
Headers  
Content-Type application/json
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
supplier_org_id STRING Yes ID of the organisation in the platform that is to supply the goods and services
customer_account_code STRING No Code of the supplying organisation's customer account. The account code is only required if the supplying organisation has assigned multiple customer accounts to the customer organisation calling the endpoint.
Body JSON Yes Body contains a Purchase Order Ecommerce Standards Document that has one or more purchase order records. The document is serialized into its JSON data string.

To see more information about the purchase order fields that the endpoint supports you can find more information at Purchase Order Records Fields.

Example Raw HTTP Request

POST https://api.squizz.com/rest/1/org/procure_purchase_order_from_supplier/402934A8234E1B997D51F23974?supplier_org_id=342429EDABC3432498737 HTTP/1.1
Host: api.squizz.com
Content-Length: 3031
Content-Type: application/json

{
    "resultStatus":"1",
    "message":"The purchase order data has been successfully obtained.",
    "configs":{},
    "dataTransferMode": "COMPLETE",
    "version": 1.1,
    "totalDataRecords": 1,
    "dataRecords":
     [
        {
            "keyPurchaseOrderID":"111",
            "purchaseOrderCode":"POEXAMPLE-345",
            "purchaseOrderNumber":"345",
            "keySupplierAccountID":"2",
            "supplierAccountCode":"ACM-002",
            "supplierAccountName":"Acme Supplies",
            "currencyISOCode": "AUD",
            "deliveryContact":"Jane Doe",
            "deliveryOrgName":"Acme Industries",
            "deliveryEmail":"js@someemailaddress.comm",
            "deliveryPhone":"+6144433332222",
            "deliveryFax":"+6144433332221",
            "deliveryAddress1":"Unit 5",
            "deliveryAddress2":"22 Bourkie Street",
            "deliveryAddress3":"Melbourne",
            "deliveryPostcode":"3000",
            "deliveryRegionName":"Victoria",
            "deliveryCountryName":"Australia",
            "deliveryCountryCodeISO2":"AU",
            "deliveryCountryCodeISO3":"AUS",
            "billingContact":"John Citizen",
            "billingOrgName":"Acme Industries International",
            "billingEmail":"ms@someemailaddress.comm",
            "billingPhone":"+61445242323423",
            "billingFax":"+61445242323421",
            "billingAddress1":"43",
            "billingAddress2":"High Street",
            "billingAddress3":"Melbourne",
            "billingPostcode":"3000",
            "billingRegionName":"Victoria",
            "billingCountryName":"Australia",
            "billingCountryCodeISO2":"AU",
            "billingCountryCodeISO3":"AUS",
            "instructions":"Leave goods at the back entrance",
            "isDropship":"N",
            "lines":
            [
                {
                    "lineType":"PRODUCT",
                    "quantity": 4,
                    "priceExTax": 5.00,
                    "priceIncTax": 5.50,
                    "priceTax": 0.50,
                    "priceTotalExTax": 20.00,
                    "priceTotalIncTax": 22.00,
                    "priceTotalTax": 2.00,
                    "unitName": "EACH",
                    "productCode": "TEA-TOWEL-GREEN",
                    "productName": "Green tea towel - 30 x 6 centimetres"  ,
                    "salesOrderProductCode": "SUPPLIER-TOWEL-GRN"


                },
                {
                    "lineType":"PRODUCT",
                    "quantity": 2,
                    "priceExTax": 5.00,
                    "priceIncTax": 5.50,
                    "priceTax": 0.50,
                    "priceTotalExTax": 10.00,
                    "priceTotalIncTax": 11.00,
                    "priceTotalTax": 1.00,
                    "unitName": "EACH",
                    "productCode": "TEA-TOWEL-BLUE",
                    "productName": "Blue tea towel - 30 x 6 centimetres",
                    "salesOrderProductCode": "SUP-TEA-TOWEL-BLUE"
                }
            ]
        }
    ]
}

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the data was imported into the platform against the organsiation.
configs.api_version DECIMAL Version of the SQUIZZ.com platform's API used to handle the request
configs.result_code STRING

Status code of trying to import the ESD document data. The following codes could be returned:

  • SERVER_SUCCESS
    The purchase orders were successfully procured, converted into sales orders and sent for processing in the supplier organisation.
     
  • SERVER_ERROR_ORG_DOES_NOT_EXIST
    The supplier organisation with the given organisation ID could not be found or is not active within the platform. Check with the supplier organisation that their organisation ID issued by the platform is correct.
     
  • SERVER_ERROR_SESSION_INVALID
    The session used to call the endpoint has expired, or never existed. Look at calling the Create Session endpoint to get another session ID.
     
  • SERVER_ERROR_ORG_NOT_SELLING
    The supplier organisation is not currently selling on the platform. The supplier organisation would need to change its Trading Status to Fully Trading or Selling Only to allow the purchase orders to be procured.
     
  • SERVER_ERROR_NO_ORG_CUSTOMER_ACCOUNT_SET
    The supplier organisation has not assigned any customer account to the customer organisation. The supplier organiation needs to import and assign the customer organisation to a customer account.
     
  • SERVER_ERROR_NO_ORG_CUSTOMER_ACCOUNT_ASSIGNED
    The supplier organisation has not assigned any customer account to the customer organisation. The supplier organiation needs to import and assign the customer organisation to a customer account.
     
  • SERVER_ERROR_CUSTOMER_ACCOUNT_NO_ACCOUNT_PAYMENT_TYPE
    The supplier organisation's customer account assigned to the customer organisation does not have any On Account payment type assigned to it. Because of this the customer organisation cannot pay for the ordered products. The supplier organisatio may need to import an On Account payment type into the platform, and assign the customer account to this payment type if it wishes to allow the customer organisation to purchase.
     
  • SERVER_ERROR_ORDER_PRODUCT_NOT_MAPPED
    One or more of the products in the purchase orders received cannot be mapped to the supplier's products, or the customer organisation does not have permission to purchase the products (based on the data sharing policy that the customer organisation is assigned to).  See the "configs.orders_with_unmapped_lines"  attribute returned by the endpoint to determine the lines within the purchase orders that have been unmapped and may require a person to resolve.
     
  • SERVER_ERROR_ORDER_MAPPED_PRODUCT_PRICE_NOT_FOUND
    One or more of the products in the purchase orders received was matched on a supplier's product, however no pricing could be found for the product(s) based on the customer account assigned to the purchasing organisation. Because of this the platform is unable to price the supplier's product. This would indicate either that the supplier organisation has intentionally not set a price for the customer account, thus not giving permission to sell the product to the customer organisation, or the supplier organisation has not imported pricing for the product(s) into the platform as yet. See the "configs.orders_with_unpriced_lines"  attribute returned by the endpoint to determine the lines within the purchase orders that have been unpriced and may require a person to resolve.
     
  • SERVER_ERROR_ORDER_MAPPED_PRODUCT_STOCK_NOT_AVAILABLE
    All of the products in the purchase orders received was able to be matched to the supplier organisation's products, however one or more of the supplier's product was out of stock.  See the "configs.orders_with_unstocked_lines"  attribute returned by the endpoint to determine the lines within the purchase orders that don't have stock available and may require a person to resolve.
     
  • SERVER_ERROR_ORG_NOT_ENOUGH_CREDITS
    The supplier organisation does not have enough trading tokens within the platform to allow the sales orders to be created. The supplier organisation needs to purchase more trading tokens to allow it to sell products and generate sales orders through this endpoint.
     
  • SERVER_ERROR_DATA_JSON_WRONG_CONTENT_TYPE
    The content type set in the HTTP Request Header is missing or not correctly set to "application/json". Ensure that the body of the HTTP request also has the purchase order data set in the JSON dat format.
configs.orders_with_unmapped_lines STRING Contains a comma delimited list of key value pairs (that each are colon delimited) that specifies the index of the purchase order record and the index of the line within the record that could not be matched to a supplier's product, or the supplier's product was out of stock, or the customer organisation does not have permission to purchase.

For example if this value was set to "1:2,1:3,4:0", Then it would specify that the 2nd purchase order record (index 1) within the dataRecords array of the purchase orders uploaded in the endpoint request has lines 3 and 4 that have unmapped products (line indexes 2 and 3), and for the 5th purchase order record (record index 4) the 1st order line has an unmapped product (line index 0).
configs.orders_with_unpriced_lines STRING Contains a comma delimited list of key value pairs (that each are colon delimited) that specifies the index of the purchase order record and the index of the line within the record that could not be priced for a supplier's product. This indicates that supplier products were found for the purchase order lines but that the supplier organisation had not set any pricing of the products, based on the customer account that that the customer organisation was assigned to.

For example if this value was set to "2:1,2:3,5:0", Then it would specify that the 3rd purchase order record (index 2) within the dataRecords array of the purchase orders uploaded in the endpoint request has lines 2 and 4 that have unpriced products (line indexes 1 and 3), and for the 6th purchase order record (record index 5) the 1st order line has an un-priced product (line index 0).
configs.orders_with_unstocked_lines STRING Contains a comma delimited list of key value pairs (that each are colon delimited) that specifies the index of the purchase order record and the index of the line within the record that were out of stock for a supplier's product. This indicates that supplier products were found for the purchase order lines but that the supplier organisation had no stock available for the products listed this attribute.

For example if this value was set to "2:1,2:3,5:0", Then it would specify that the 3rd purchase order record (index 2) within the dataRecords array of the purchase orders uploaded in the endpoint request has lines 2 and 4 that have un-stocked products (line indexes 1 and 3), and for the 6th purchase order record (record index 5) the 1st order line has an un-stocked product (line index 0).
dataRecords JSON ARRAY List of Sales Order Ecommerce Standards Records. Each record contains details of the corresponding supplier's sales order that was generated from each purchase order. These details include sales order number, order line pricing, surcharge prices (such as freight and shipping)

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS", "dataRecords":[list_of_sales_order_records]}

Web Service Endpoint: Send Customer Invoice To Customer

The endpoint is used by a supplier organisation to push one or more invoices into the platform and have it be passed to a customer organisation, we it can then be imported back into the customer's business system. This allows organisations who supply goods and services to other organisations to automate the invoicing process, save time and money for both suppliers and customers. When a supplier organisation sends a "customer invoice" through this API endpoint, it will convert the customer invoice into a supplier invoice, and if the purchaser organisation requires it the invoice's lines can be matched up to the purchasers products, surcharges and taxcodes. This may then allow the invoice to be imported into the purchaser organisation's business system with its own codes.

 

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/send_customer_invoice_to_customer/session_id?customer_org_id=[org_id]&supplier_account_code=[supplier_account_code]
Headers  
Content-Type application/json
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
customer_org_id STRING Yes ID of the organisation in the platform that is to recieve the invoice.
supplier_account_code STRING No Code of the customer organisation's supplier account. The account code is only required if the customer organisation has assigned multiple supplier accounts (a.k.a. creditors or vendors) to the supplier organisation calling the endpoint.
Body JSON Yes Body contains a Customer Invoice Ecommerce Standards Document that has one or more customer invoice records. The document is serialized into its JSON data string.

To see more information about the customer invoice fields that the endpoint supports you can find more information at Customer Invoice Records Fields.

Example Raw HTTP Request

POST https://api.squizz.com/rest/1/org/send_customer_invoice_to_customer/402934A8234E1B997D51F23974?supplier_org_id=342429EDABC3432498737 HTTP/1.1
Host: api.squizz.com
Content-Length: 3031
Content-Type: application/json

{
    "resultStatus":"1",
    "message":"The customer invoice data has been successfully obtained.",
    "configs":{},
    "dataTransferMode": "COMPLETE",
    "version": 1.1,
    "totalDataRecords": 1,
    "dataRecords":
     [
        {
            "keyPurchaseOrderID":"111",
            "purchaseOrderCode":"POEXAMPLE-345",
            "purchaseOrderNumber":"345",
            "keySupplierAccountID":"2",
            "supplierAccountCode":"ACM-002",
            "supplierAccountName":"Acme Supplies",
            "currencyISOCode": "AUD",
            "deliveryContact":"Jane Doe",
            "deliveryOrgName":"Acme Industries",
            "deliveryEmail":"js@someemailaddress.comm",
            "deliveryPhone":"+6144433332222",
            "deliveryFax":"+6144433332221",
            "deliveryAddress1":"Unit 5",
            "deliveryAddress2":"22 Bourkie Street",
            "deliveryAddress3":"Melbourne",
            "deliveryPostcode":"3000",
            "deliveryRegionName":"Victoria",
            "deliveryCountryName":"Australia",
            "deliveryCountryCodeISO2":"AU",
            "deliveryCountryCodeISO3":"AUS",
            "billingContact":"John Citizen",
            "billingOrgName":"Acme Industries International",
            "billingEmail":"ms@someemailaddress.comm",
            "billingPhone":"+61445242323423",
            "billingFax":"+61445242323421",
            "billingAddress1":"43",
            "billingAddress2":"High Street",
            "billingAddress3":"Melbourne",
            "billingPostcode":"3000",
            "billingRegionName":"Victoria",
            "billingCountryName":"Australia",
            "billingCountryCodeISO2":"AU",
            "billingCountryCodeISO3":"AUS",
            "instructions":"Leave goods at the back entrance",
            "isDropship":"N",
            "lines":
            [
                {
                    "lineType":"PRODUCT",
                    "quantity": 4,
                    "priceExTax": 5.00,
                    "priceIncTax": 5.50,
                    "priceTax": 0.50,
                    "priceTotalExTax": 20.00,
                    "priceTotalIncTax": 22.00,
                    "priceTotalTax": 2.00,
                    "unitName": "EACH",
                    "productCode": "TEA-TOWEL-GREEN",
                    "productName": "Green tea towel - 30 x 6 centimetres"  ,
                    "salesOrderProductCode": "SUPPLIER-TOWEL-GRN"


                },
                {
                    "lineType":"PRODUCT",
                    "quantity": 2,
                    "priceExTax": 5.00,
                    "priceIncTax": 5.50,
                    "priceTax": 0.50,
                    "priceTotalExTax": 10.00,
                    "priceTotalIncTax": 11.00,
                    "priceTotalTax": 1.00,
                    "unitName": "EACH",
                    "productCode": "TEA-TOWEL-BLUE",
                    "productName": "Blue tea towel - 30 x 6 centimetres",
                    "salesOrderProductCode": "SUP-TEA-TOWEL-BLUE"
                }
            ]
        }
    ]
}

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the data was imported into the platform against the organsiation.
configs.api_version DECIMAL Version of the SQUIZZ.com platform's API used to handle the request
configs.result_code STRING

Status code of trying to import the ESD document data. The following codes could be returned:

  • SERVER_SUCCESS
    The customer invoices were successfully send, converted into supplier invoices and sent for processing in the customer organisation.
     
  • SERVER_ERROR_ORG_DOES_NOT_EXIST
    The customer organisation with the given organisation ID could not be found or is not active within the platform. Check with the customer organisation that their organisation ID issued by the platform is correct.
     
  • SERVER_ERROR_SESSION_INVALID
    The session used to call the endpoint has expired, or never existed. Look at calling the Create Session endpoint to get another session ID.
     
  • SERVER_ERROR_ORG_NOT_BUYING
    The customer organisation is not currently buying on the platform. The customer organisation would need to change its Trading Status to Fully Trading or Buying Only to allow the invoices to be received.
     
  • SERVER_ERROR_NO_ORG_SUPPLIER_ACCOUNT_SET
    The customer organisation has not assigned any supplier account to the supplier organisation. The customer organiation needs to import and assign the supplier organisation to a supplier account.
     
  • SERVER_ERROR_NO_ORG_SUPPLIER_ACCOUNT_ASSIGNED
    The customer organisation has not assigned any supplier account to the supplier organisation. The customer organiation needs to import and assign the supplier organisation to a supplier account.
     
  • SERVER_ERROR_ORDER_PRODUCT_NOT_MAPPED
    One or more of the products in the customer invoices received cannot be mapped to the customer's products. See the "configs.invoices_with_unmapped_lines"  attribute returned by the endpoint to determine the lines within the customer invoice that have been unmapped and may require a person to resolve.
     
  • SERVER_ERROR_ORG_NOT_ENOUGH_CREDITS
    The supplier or customer organisation does not have enough trading tokens within the platform to allow the supplier invoices to be created. Either the supplier organisation needs to purchase more trading tokens to allow it to send invoices through this endpoint, or the customer organisation needs to give permission for the invoice to be paid by their trading tokens and that they have enough trading tokens.
     
  • SERVER_ERROR_DATA_JSON_WRONG_CONTENT_TYPE
    The content type set in the HTTP Request Header is missing or not correctly set to "application/json". Ensure that the body of the HTTP request also has the customer invoice data set in the JSON dat format.
configs.invoices_with_unmapped_lines STRING Contains a comma delimited list of key value pairs (that each are colon delimited) that specifies the index of the customer invoice record and the index of the line within the record that could not be matched to a customer's product.

For example if this value was set to "1:2,1:3,4:0", Then it would specify that the 2nd customer invoice record (index 1) within the dataRecords array of the invoices uploaded in the endpoint request has lines 3 and 4 that have unmapped products (line indexes 2 and 3), and for the 5th customer invoice record (record index 4) the 1st order line has an unmapped product (line index 0).
dataRecords JSON ARRAY List of Supplier Invoice Ecommerce Standards Records. Each record contains details of the corresponding customer's supplier invoice that was generated from each customer invoice. These details include supplier invoice number, invoice line pricing, surcharge prices (such as freight and shipping)

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS", "dataRecords":[list_of_supplier_invoice_records]}

Web Service Endpoint: Search Organisation Customer Account Records

Web Service Endpoint: Retrieve Organisation Customer Account Record

Web Service Endpoint: Create Organisation Notification

The endpoint allows an organisation notification to be created in the platform and sent to the relevant people assigned to the organisation's notification category. This endpoint allows external systems to raise notifications in the platform containing a tailored message. This endpoint could be used to alert organisation people of events happening outside of the platform that warrents their attention, such as events happening within a website, business system, or other software. These notifications may also be sent as push notifications to mobile devices that have the Squizz.com app installed. Note that there are trading token costs to create organisation notifications, of which the organisation must have enough tokens to allow the notification to be raised. See the Trading Tokens and Pricing document for costs.

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/create_notification/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
notify_category STRING Yes Organisation category to place the notification within. Set one of the values:
  • org
  • account
  • order_sale
  • order_purchase
  • feed
message STRING Yes Message to place into the notification. All characters are treated a literals, however you may embed up to 5 links or labels into the message using the placeholder text formats:
  • {1}
  • {2}
  • {3}
  • {4}
  • {5}
link1_url STRING No URL of the link to place in the notification message where the placeholder {1} has been set
link1_label STRING No label to place in the notification message where {1} is set. This label may be set as a link if link1_url has been set.
link2_url STRING No URL of the link to place in the notification message where the placeholder {2} has been set
link2_label STRING No label to place in the notification message where {2} is set. This label may be set as a link if link2_url has been set.
link3_url STRING No URL of the link to place in the notification message where the placeholder {3} has been set
link3_label STRING No label to place in the notification message where {3} is set. This label may be set as a link if link3_url has been set.
link4_url STRING No URL of the link to place in the notification message where the placeholder {4} has been set
link4_label STRING No label to place in the notification message where {4} is set. This label may be set as a link if link4_url has been set.
link5_url STRING No URL of the link to place in the notification message where the placeholder {5} has been set
link5_label STRING No label to place in the notification message where {5} is set. This label may be set as a link if link5_url has been set.

 

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the notification was created.
result_code STRING Status code of trying to create the notification. See the Appendix I for the list of possible result codes.
api_version STRING Version of the API being used to handle the endpoint request.

 

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS"}

Web Service Endpoint: Validate Organisation Security Certificate

The endpoint validates an TLS/SSL x509 security certificate that was created in the organisation's profile. The source IP address of the API HTTP request is validated against the IP address or related domain (via DNS lookup) set in the certificate. If the checks pass then the security certificate becomes active.This endpoint is used to make sure that security certificates are being issued against legitimate public IP addresses or domains that the organisation is in control of.

HTTP Request

HTTP Method POST
HTTP URL https://api.squizz.com/rest/1/org/validate_cert/session_id
Parameters Data Type Mandatory Description
session_id STRING Yes ID of the API session. Place the session ID within the URL
org_security_certificate_id STRING Yes ID of the security certificate created in the organisation's profile

 

HTTP Response

Response Data Type JSON
     
Parameters Data Type Description
result ENUM (SUCCESS or FAILURE) Either "SUCCESS" or "FAILURE". If successful then the certificate was validated.
result_code STRING Status code of trying to validate the certificate. See the Appendix I for the list of possible result codes.
api_version STRING Version of the API being used to handle the endpoint request.

 

HTTP Response Example:

{"result":"SUCCESS", "api_version":"1.0.0.0", "result_code":"SERVER_SUCCESS"}

Outgoing Request: Get Customer Account Enquiry Records

The Squizz.com platform can send out a request to an organisation's connected business system to request a list of records associated to a customer account in the organisation's business system. This allows data such as invoices, sales orders, back orders, credits, payments, and transactions to be all queried in real time, and filtered over a certain date range. The platform will only make requests to obtain this customer account data if the person is connected to the organisation and has permission to request the data based on their relationship to a customer account. This request can be used to help a person find one or more records that they are looking for.

HTTP Request

HTTP Method GET
HTTP URL https://[ipaddress_domain]/squizzconnector/data/customer_account_enquiry_records
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
keyCustomerAccountID STRING Yes Unique ID of the organisation's customer account
recordType STRING Yes ID of type of records to obtain. Set to one of the following:
  • INVOICE
  • TRANSACTION
  • ORDER_SALE
  • BACKORDER
  • CREDIT
  • PAYMENT
beginDate LONG No Datetime to obtain records from. Datetime is set as milliseconds since the 01-01-1970 UTC epoch
endDate LONG No Datetime to obtain records to. Datetime is set as milliseconds since the 01-01-1970 UTC epoch
pageNumber INTEGER Yes The page number to display records on.
numberOfRecords INTEGER Yes Number of records to display per page.
outstandingRecords ENUM No If true then only obtain records that are outstanding or unpaid. Ignore if not given or empty
keyRecordIDs STRING No Comma delimited list of records to find based on each record's keyRecordID. Ignore if not given or empty.
searchString STRING No text to match record data on. The field to search on is based on the search type given. Ignore if the searchType has not been given or is empty.
searchType STRING No The field within the records to search and match the search string on. Ignore if not given or empty.
orderByField STRING No The field to order the records by. If not given or empty then sort by the record's date field.
orderByDirection ENUM (DESC or ASC) No The direction to order the records by. Set to either DESC-descending or ASC-ascending. By default order by descending

 

HTTP Response

Response Data Type JSON
Response Body ESDocumentCustomerAccountEnquiry
Returns serialized JSON of a ESDocumentCustomerAccountEnquiry document containing a list of customer account records for the given record type.

Outgoing Request: Get Customer Account Enquiry Record

The Squizz.com platform can send out a request to an organisation's connected business system to request the details of a single record associated to a customer account in the organisation's business system. This allows data such as an invoice, sales order, back order, credit or payment record to be queried in real time. The platform will only make requests to obtain this customer account record data if the person is connected to the organisation and has permission to request the data based on their relationship to a customer account.

HTTP Request

HTTP Method GET
HTTP URL https://[ipaddress_domain]/squizzconnector/data/customer_account_enquiry_record
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
keyCustomerAccountID STRING Yes Unique ID of the organisation's customer account
recordType STRING Yes ID of type of record to obtain. Set to one of the following:
  • INVOICE
  • TRANSACTION
  • ORDER_SALE
  • BACKORDER
  • CREDIT
  • PAYMENT
keyRecordID STRING Yes Unique ID of the customer account record to obtain.

 

HTTP Response

Response Data Type JSON
Response Body ESDocumentCustomerAccountEnquiry
Returns serialized JSON of a ESDocumentCustomerAccountEnquiry document containing a single record in the records list for the given record type.

Outgoing Request: Get Supplier Account Enquiry Records

The Squizz.com platform can send out a request to an organisation's connected business system to request a list of records associated to a supplier account in the organisation's business system. This allows data such as purchase orders to be all queried in real time, and filtered over a certain date range. The platform will only make requests to obtain this supplier account data if the person is connected to the organisation and has permission to request the data based on their relationship to a supplier account. This request can be used to help a person find one or more records that they are looking for, which can be used to then convert purchase orders into sales orders associated to a supplier organisation.

HTTP Request

HTTP Method GET
HTTP URL https://[ipaddress_domain]/squizzconnector/data/supplier_account_enquiry_records
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
keySupplierAccountID STRING Yes Unique ID of the organisation's supplier account
recordType STRING Yes ID of type of records to obtain. Set to one of the following:
  • ORDER_PURCHASE
beginDate LONG No Datetime to obtain records from. Datetime is set as milliseconds since the 01-01-1970 UTC epoch
endDate LONG No Datetime to obtain records to. Datetime is set as milliseconds since the 01-01-1970 UTC epoch
pageNumber INTEGER Yes The page number to display records on.
numberOfRecords INTEGER Yes Number of records to display per page.
outstandingRecords ENUM No If true then only obtain records that are outstanding or unpaid. Ignore if not given or empty
keyRecordIDs STRING No Comma delimited list of records to find based on each record's keyRecordID. Ignore if not given or empty.
searchString STRING No text to match record data on. The field to search on is based on the search type given. Ignore if the searchType has not been given or is empty.
searchType STRING No The field within the records to search and match the search string on. Ignore if not given or empty.
orderByField STRING No The field to order the records by. If not given or empty then sort by the record's date field.
orderByDirection ENUM (DESC or ASC) No The direction to order the records by. Set to either DESC-descending or ASC-ascending. By default order by descending

 

HTTP Response

Response Data Type JSON
Response Body ESDocumentSupplierAccountEnquiry
Returns serialized JSON of a ESDocumentSupplierAccountEnquiry document containing a list of customer account records for the given record type.

Outgoing Request: Get Supplier Account Enquiry Record

The Squizz.com platform can send out a request to an organisation's connected business system to request the details of a single record associated to a supplier account in the organisation's business system. This allows data such as a purchase order record to be queried in real time. The platform will only make requests to obtain this supplier account record data if the person is connected to the organisation and has permission to request the data based on their relationship to a supplier account.

HTTP Request

HTTP Method GET
HTTP URL https://[ipaddress_domain]/squizzconnector/data/supplier_account_enquiry_record
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
keySupplierAccountID STRING Yes Unique ID of the organisation's supplier account
recordType STRING Yes ID of type of record to obtain. Set to one of the following:
  • ORDER_PURCHASE
keyRecordID STRING Yes Unique ID of the supplier account record to obtain.

 

HTTP Response

Response Data Type JSON
Response Body ESDocumentSupplierAccountEnquiry
Returns serialized JSON of a ESDocumentSupplierAccountEnquiry document containing a single record in the records list for the given record type.

Outgoing Request: Post Purchase Order

The Squizz.com platform can send out a request to an organisation's connected business system to post a purchase order. This allows purchasers who have imported a purchase order into the platform to submit the purchase order back to the organisation's system without needing to do manual data entry. The platform will only make requests to post a purchase order if the person is connected to the organisation and has permission to post purchase orders.

HTTP Request

HTTP Method POST
HTTP URL https://[ipaddress_domain]/squizzconnector/data/import_purchase_orders
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
Request Body JSON Yes Serialized form of the ESDocumentOrderPurchase document containing one ESDRecordOrderPurchase record in the JSON.

 

HTTP Response

Response Data Type JSON
Response Body ESDocument
Returns serialized JSON of a ESDocument with the resultStatus property specifying if the order successfully imported or not.

Outgoing Request: Post Sales Order

The Squizz.com platform can send out a request to an organisation's connected business system to post a sales order. This allows sales orders that have been created in the platform by customers to submit the sales order back to the organisation's system without needing to do manual data entry. The platform will only make requests to post a sales order if the person is connected to the organisation and has permission to post sales orders, or otherwise a sales order has been created through the platform's API by an organisation who has permission to raise sales orders from purchase orders that they have submitted.

HTTP Request

HTTP Method POST
HTTP URL https://[ipaddress_domain]/squizzconnector/data/import_sales_orders
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
Request Body JSON Yes Serialized form of the ESDocumentOrderSale document containing one ESDRecordOrderSale record in the JSON.

 

HTTP Response

Response Data Type JSON
Response Body ESDocument
Returns serialized JSON of a ESDocument with the resultStatus property specifying if the order successfully imported or not.

Outgoing Request: Post Customer Account Invoice Payment

The Squizz.com platform can send out a request to an organisation's connected business system to post a payment made against an invoice for a given customer account.This allows customers to pay for invoices through the platform, then have the payment automatically posted back against the invoice record in the organisation's business system.

HTTP Request

HTTP Method POST
HTTP URL https://[ipaddress_domain]/squizzconnector/data/import_customer_account_payment
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
Request Body JSON Yes Serialized form of the ESDocumentCustomerAccountPayment document containing one ESDRecordCustomerAccountPayment record in the JSON.

 

HTTP Response

Response Data Type JSON
Response Body ESDocument
Returns serialized JSON of a ESDocument with the resultStatus property specifying if the payment successfully imported or not.

Outgoing Request: Get Connector Status

The Squizz.com platform can send out a request to an organisation's connected software to check its status and to test that the credentials to access it are correct. This endpoint can be called from within the organisation's profile, under the admin section, from within the Connector Settings dialog by clicking on the Test Connection button.

HTTP Request

HTTP Method GET
HTTP URL https://[ipaddress_domain]/squizzconnector/data/connector_status
Request Header Data Type Mandatory Description
Accept-Encoding STRING Yes Set to gzip-deflate. Responses from the webservice/connector should compress data to reduce the download times.
Authorization STRING Yes Contains a base64 encoded string containing the username and password configured in the organisation's profile admin section, in the Connector Settings dialog.This is used to authenticate that the incoming request from Squizz.com is allowed to be processed by the webservice, using Basic Authentication.
Squizz-Org-ID STRING Yes ID of the organisation issued by squizz.comThis may be optionally used to further authenticate the incoming request from Squizz.com.
Parameters Data Type Mandatory Description
ipaddress_domain STRING Yes The public IP address or domain used to call the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.
port STRING Yes The port number to make the request to against the organisation's designated webservice/Connector. Set within the URL. This can be configured in the Admin area of an organisation's profile, within the Connector settings dialog.

 

HTTP Response

Response Data Type JSON
Response Body ESDocument
Returns serialized JSON of a ESDocument with the resultStatus and message properties specifying if the status of the webservice is running OK.