business/deals methods

Last modified: 25. September 2023

Retrieve a list of deals

❗This method is deprecated and has been split into new 2 methods.

Search for deals

❗This method is deprecated and has been split into new 2 methods.

Retrieving general information for an existing order/deal

Retrieve information from an existing order/order using its unique ITscope deal number 11SRRK-150126-1136

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

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

Archiving an existing order/deal

Archiving an existing order/order using its unique ITscope deal number 11SRRK-150126-1136. The HTTP request method for this function is PUT, instead of GET.

e.g.: https://api.itscope.com/2.1/business/deals/archive/11SRRK-150126-1136

The article on the topic of archives explains why archiving should be done.

Confirming a deal received as a seller (API version 2.1 only)

Confirming a received deal using its unique ITscope deal number, e.g. 11SRRK-150126-1136. The HTTP request method for this function is PUT, instead of GET.

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

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

A self-created order confirmation in the OpenTrans 2.1 format ‘ORDERRESPONSE‘ can also be sent to this endpoint, in which case POST must be used instead of PUT.

Creating a delivery note for a deal received as a seller (API version 2.1 only)

Create a delivery note for a received deal using its unique ITscope deal number, e.g. 11SRRK-150126-1136 The HTTP request method for this function is PUT, instead of GET.

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

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

A self-created delivery note in the OpenTrans 2.1 format ‘DISPATCHNOTIFICATION‘ can also be sent to this endpoint, in which case POST must be used instead of PUT.

Invoicing a deal received as a seller (API version 2.1 only)

Create an invoice for a received deal using its unique ITscope deal number, e.g. 11SRRK-150126-1136. The HTTP request method for this function is PUT, instead of GET.

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

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

A self-created invoice in the OpenTrans 2.1 format ‘INVOICE‘ can also be sent to this endpoint, in which case POST must be used instead of PUT.

Rejecting a deal received as a seller (API version 2.1 only)

Rejecting a received deal based on its unique ITscope deal number e.g. 11SRRK-150126-1136. The HTTP request method for this function is PUT, instead of GET.

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

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

A self-created order cancellation in the OpenTrans 2.1 format ‘ORDERRESPONSE‘ (see note for cancellation of line items) can also be sent to this endpoint, in which case POST must be used instead of PUT.

Was this article helpful?
Dislike 0
Views: 205