{"id":2168,"date":"2020-09-24T10:22:14","date_gmt":"2020-09-24T10:22:14","guid":{"rendered":"https:\/\/support.itscope.hostpress.me\/?post_type=kb&#038;p=2168"},"modified":"2023-09-25T09:16:48","modified_gmt":"2023-09-25T07:16:48","slug":"business-deals-methods","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/business-deals-methods\/","title":{"rendered":"business\/deals methods"},"content":{"rendered":"\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Retrieve a list of deals<\/h2>\n\n\n\n<p>\u2757This method is deprecated and has been split into new 2 methods.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/guide.itscope.com\/en\/kb\/business-deals-purchase-methods\/\">Retrieve a list of sent platform orders<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/guide.itscope.com\/en\/kb\/business-deals-sales-methods\/\">Retrieve a list of received portal deals<\/a><\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Search for deals<\/h2>\n\n\n\n<p>\u2757This method is deprecated and has been split into new 2 methods.<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><a href=\"https:\/\/guide.itscope.com\/en\/kb\/business-deals-purchase-methods\/\">Search for sent platform orders<\/a><\/li>\n\n\n\n<li><a href=\"https:\/\/guide.itscope.com\/en\/kb\/business-deals-sales-methods\/\">Search for received portal deals<\/a><\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Retrieving general information for an existing order\/deal<\/h2>\n\n\n\n<p>Retrieve information from an existing order\/order using its unique ITscope deal number 11SRRK-150126-1136<\/p>\n\n\n\n<p>e.g.:\u00a0<em>https:\/\/api.itscope.com\/2.1\/business\/deals\/11SRRK-150126-1136\/deal.xml<\/em><\/p>\n\n\n\n<p>A description of the response is provided in the\u00a0<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">format description for deals<\/a>\u00a0article.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Archiving an existing order\/deal<\/h2>\n\n\n\n<p>Archiving an existing order\/order using its unique ITscope deal number 11SRRK-150126-1136.\u00a0The HTTP request method for this function is\u00a0<strong>PUT<\/strong>, instead of GET.<\/p>\n\n\n\n<p>e.g.:\u00a0<em>https:\/\/api.itscope.com\/2.<\/em>1<em>\/business\/deals\/archive\/11SRRK-150126-1136<\/em><\/p>\n\n\n\n<p>The article on the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/archived-orders-and-customer-orders\/\">topic of archives<\/a> explains why archiving should be done.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Confirming a deal received as a\u00a0seller (API version 2.1 only)<\/h2>\n\n\n\n<p>Confirming a received deal using its unique ITscope deal number, e.g. 11SRRK-150126-1136. The HTTP request method for this function is\u00a0<strong>PUT<\/strong>, instead of GET.<\/p>\n\n\n\n<p>e.g.:&nbsp;<em>https:\/\/api.itscope.com\/2.1\/business\/deals\/confirm\/11SRRK-150126-1136<\/em><\/p>\n\n\n\n<p>This will set the buyer&#8217;s and seller&#8217;s <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">order\/deal status<\/a> to &#8216;<strong>order confirmed<\/strong>&#8216;. An <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">order response document<\/a> will be automatically generated in <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format (&#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">ORDERRESPONSE<\/a>&#8216;).<\/p>\n\n\n\n<p>A self-created order confirmation in the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format &#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">ORDERRESPONSE<\/a>&#8216; can also be sent to this endpoint, in which case <strong>POST<\/strong> must be used instead of <strong>PUT<\/strong>.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Creating a delivery note for a deal received as a seller (API version 2.1 only)<\/h2>\n\n\n\n<p>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\u00a0<strong>PUT<\/strong>, instead of GET.<\/p>\n\n\n\n<p>e.g.:&nbsp;<em>https:\/\/api.itscope.com\/2.1\/business\/deals\/advise\/11SRRK-150126-1136<\/em><\/p>\n\n\n\n<p>This will set the buyer&#8217;s and seller&#8217;s <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">order\/deal status<\/a> to &#8216;<strong>in shipment<\/strong>&#8216;. An <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">order response document<\/a> will be automatically generated in <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format (&#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">DISPATCHNOTIFICATION<\/a>&#8216;).<\/p>\n\n\n\n<p>A self-created delivery note in the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format &#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">DISPATCHNOTIFICATION<\/a>&#8216; can also be sent to this endpoint, in which case <strong>POST<\/strong> must be used instead of <strong>PUT<\/strong>.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Invoicing a\u00a0deal received as a seller (API version 2.1 only)<\/h2>\n\n\n\n<p>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\u00a0<strong>PUT<\/strong>, instead of GET.<\/p>\n\n\n\n<p>e.g.:&nbsp;<em>https:\/\/api.itscope.com\/2.1\/business\/deals\/invoice\/11SRRK-150126-1136<\/em><\/p>\n\n\n\n<p>This will set the buyer&#8217;s and seller&#8217;s <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">order\/deal status<\/a> to &#8216;<strong>invoiced<\/strong>&#8216;. An <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">order response document<\/a> will be automatically generated in <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format (&#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">INVOICE<\/a>&#8216;).<\/p>\n\n\n\n<p>A <meta charset=\"utf-8\"><\/meta>self-created invoice in the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format &#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">INVOICE<\/a>&#8216; can also be sent to this endpoint, in which case <strong>POST<\/strong> must be used instead of <strong>PUT<\/strong>.<br><\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Rejecting a deal received as a seller (API version 2.1 only)<\/h2>\n\n\n\n<p>Rejecting a received deal based on its unique ITscope deal number e.g. 11SRRK-150126-1136. The HTTP request method for this function is\u00a0<strong>PUT<\/strong>, instead of GET.<\/p>\n\n\n\n<p>e.g.:&nbsp;<em>https:\/\/api.itscope.com\/2.1\/business\/deals\/reject\/11SRRK-150126-1136<\/em><\/p>\n\n\n\n<p>This will set the buyer&#8217;s and seller&#8217;s <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">order\/deal status<\/a> to &#8216;<strong>rejected<\/strong>&#8216;. An <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">order response document<\/a> will be automatically generated in <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format (&#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">ORDERRESPONSE<\/a>&#8216;).<\/p>\n\n\n\n<p>A <meta charset=\"utf-8\"><\/meta>self-created order cancellation in the <a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-and-quote-data-in-opentrans-2-1-format\/\">OpenTrans 2.1<\/a> format &#8216;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/order-response-documents-orderresponse-dispatchnotification-invoice\/\">ORDERRESPONSE<\/a>&#8216; (see note for cancellation of line items) can also be sent to this endpoint, in which case <strong>POST<\/strong> must be used instead of <strong>PUT<\/strong>.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Retrieve a list of deals \u2757This method is deprecated and has been split into new 2 methods. Search for deals \u2757This method is deprecated and has been split into new &#8230;<\/p>\n","protected":false},"author":5,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[181],"kbtag":[],"class_list":["post-2168","kb","type-kb","status-publish","hentry","kbtopic-api-methods-business"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2168","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb"}],"about":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/types\/kb"}],"author":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/users\/5"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=2168"}],"version-history":[{"count":11,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2168\/revisions"}],"predecessor-version":[{"id":15257,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/2168\/revisions\/15257"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=2168"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=2168"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=2168"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}