Retrieving a list of existing deals

The following query parameters are possible:

  • archive
    • ARCHIVED: archived deals
    • NOTARCHIVED: deals that have not been archived
  • businessType
    • PURCHASE: outbound orders, i.e. for buyers
    • SALES: incoming orders, i.e. for sellers
  • sort - criteria for sorting
    • LAST_MODIFIED: modification date descending
    • SENT_DESC: date sent descending
    • SEND_ASC: date sent ascending
    • SUPPLIER: descending according to supplier
    • ID: descending according to ITscope order number
  • page
    •  1..n, retrievals are always limited to 50 deals per page

For example: https://api.itscope.com/2.0/business/deals/deal.xml&businessType=PURCHASE 

A description of the response is provided in the format description for orders article.

 

Searching for existing deals

Following filters can be used:

  • keywords: partial search for orderId, ownOrderId and customerOrderId, e.g. keywords=11SRRK
  • orderId (or legacy: dealId): ITscope unique order number, e.g. orderId=11SRRK-150126-1136
  • ownOrderId (or legacy: ownDealId): the order number assigned by the seller, e.g. ownOrderId=54321
  • customerOrderId (or legacy: customerDealId): the end customer's order number, e.g. customerOrderId=12345
  • status: filter according to order status, e.g. status=ADVISED
  • cartId: filter according to the shopping cart IDs that correspond to the order*

* API 2.1 only, see here.

The following query parameters are possible:

  • archive
    • ARCHIVED: archived deals
    • NOTARCHIVED: deals that have not been archived
  • businessType
    • PURCHASE: outbound orders, i.e. for buyers
    • SALES: incoming orders, i.e. for sellers
  • sort - criteria for sorting
    • LAST_MODIFIED: modification date descending
    • SENT_DESC: date sent descending
    • SEND_ASC: date sent ascending
    • SUPPLIER: descending according to supplier
    • ID: descending according to ITscope order number
  • page
    •  1..n, retrievals are always limited to 50 deals per page
  • lastUpdateDateFrom (API 2.1 only)
    • from date range in the form of yyyy-MM-dd
    • see the section in this article on restricting searches based on the last modification date of an order
  • lastUpdateDateTo (API 2.1 only)
    • up to date range in the form of yyyy-MM-dd
    • see the section in this article on restricting searches based on the last modification date of an order

 

Example search for a seller's order ID (54231)

https://api.itscope.com/2.0/business/deals/search/ownOrderID%3D54231/deal.xml?businessType=PURCHASE 

Example search for an end customer's order ID (12345)

https://api.itscope.com/2.0/business/deals/search/customerOrderID%3D12345/deal.xml?businessType=PURCHASE 

 

Example search for all orders belonging to a shopping cart with an ID of 611e-ac7b-42c2-a3b6-2434812ede75

https://api.itscope.com/2.0/business/deals/search/cartId%3D611-ac7b-42c2-a3b6-2434812ede75/deal.xml?businessType=PURCHASE 

A description of the response is provided in the format description for orders article.

 

Restricting the search according to last modification date (API 2.1 only)

The corresponding request parameters are only available starting with API 2.1. Parameters filter according to the statusDate field of the order, see format description for orders. The modification date indicates when a new transaction document was last added to the order, or when the order was last changed in some way.

  • lastUpdateDateFrom: the starting date for restricting the date range of the order modification point in the form of yyyy-MM-dd. Orders will only be filtered according to the modification date range if this parameter has been set. The time is always set to 00:00:00.
  • lastUpdateDateTo: the end date for restricting the date range of the order modification point in the form of yyyy-MM-dd. If no value is transmitted, then the current date will be taken as the default value. The time is always set to 00:00:00. The date must be after the date selected for lastUpdateDateFrom.

Retrieving general information for an existing deal

The following URL is an example of retrieving deal information of an order that has already been sent from the ITscope portal, using the ITscope order number '11SRRK-150126-1136':

https://api.itscope.com/2.0/business/deals/11SRRK-150126-1136/deal.xml

A description of the response is provided in the format description for orders article.

 

Archiving an existing deal

The following URL is an example of archiving an order that has already been sent from the ITscope portal, using the ITscope order number '11SRRK-150126-1136'. The HTTP request method for this function is PUT, instead of GET.

https://api.itscope.com/2.0/business/deals/archive/11SRRK-150126-1136

Please refer to the article on archived orders for more information on archiving.

 

Confirming an order received as a distributor (API version 2.1 only)

The following URL is an example of confirming an order that has been received in the portal, using the ITscope order number '11SRRK-150126-1136'. The HTTP request method for this function is PUT, instead of GET.

https://api.itscope.com/2.1/business/deals/confirm/11SRRK-150126-1136

This will set the buyer's and seller's order status to 'order confirmed'. An order response document will be automatically generated in OpenTrans 2.1 format ('ORDERRESPONSE').

 

Creating a delivery note for an order received as a distributor (API version 2.1 only)

The following URL is an example of creating a delivery note for an order that has been received in the portal, using the ITscope order number '11SRRK-150126-1136'. The HTTP request method for this function is PUT, instead of GET.

https://api.itscope.com/2.1/business/deals/advise/11SRRK-150126-1136

This will set the buyer's and seller's order status to 'in shipment'. An order response document will be automatically generated in OpenTrans 2.1 format ('DISPATCHNOTIFICATION').

 

Invoicing an order received as a distributor (API version 2.1 only)

The following URL is an example of creating an invoice for an order that has been received in the portal, using the ITscope order number '11SRRK-150126-1136'. The HTTP request method for this function is PUT, instead of GET.

https://api.itscope.com/2.1/business/deals/invoice/11SRRK-150126-1136

This will set the buyer's and seller's order status to 'invoiced'. An order response document will be automatically generated in OpenTrans 2.1 format ('INVOICE').

 

Rejecting an order received as a distributor (API version 2.1 only)

The following URL is an example of rejecting an order that has been received in the portal, using the ITscope order number '11SRRK-150126-1136'. The HTTP request method for this function is PUT, instead of GET.

https://api.itscope.com/2.1/business/deals/reject/11SRRK-150126-1136

This will set the buyer's and seller's order status to 'rejected'. An order response document will be automatically generated in OpenTrans 2.1 format ('ORDERRESPONSE').

 

Note: This page has been translated with the Google Translation Service.

Have more questions? Submit a request