{"id":15244,"date":"2023-09-25T08:50:36","date_gmt":"2023-09-25T06:50:36","guid":{"rendered":"https:\/\/guide.itscope.com\/?post_type=kb&#038;p=15244"},"modified":"2025-04-23T12:17:04","modified_gmt":"2025-04-23T10:17:04","slug":"business-deals-purchase-methods","status":"publish","type":"kb","link":"https:\/\/guide.itscope.com\/en\/kb\/business-deals-purchase-methods\/","title":{"rendered":"business\/deals\/purchase methods"},"content":{"rendered":"\n<p>These methods are for purchase orders<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Retrieve a list of sent platform orders<\/h2>\n\n\n\n<p>The following query parameters are possible<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>lastUpdateDateFrom&nbsp;\n<ul class=\"wp-block-list\">\n<li>from the date of the last update. Filters out only those orders where something has really changed since date x. In other words, new response documents have been added<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>lastUpdateDateTo \n<ul class=\"wp-block-list\">\n<li>to the date of the last update. Filters out only those orders where something has really changed up to date x. In other words, new response documents have been added<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>archiv\n<ul class=\"wp-block-list\">\n<li>ARCHIVED: archived orders<\/li>\n\n\n\n<li>NOTARCHIVED: unarchived orders<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>sort &#8211; Sortierungskriterien\n<ul class=\"wp-block-list\">\n<li>LAST_MODIFIED : Change date descending<\/li>\n\n\n\n<li>SENT_DESC: Shipping date in descending order<\/li>\n\n\n\n<li>SEND_ASC: Shipping date in ascending order<\/li>\n\n\n\n<li>SUPPLIER: descending according to supplier<\/li>\n\n\n\n<li>ID: descending according to the unique ITscope order number (orderId field)<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>page\n<ul class=\"wp-block-list\">\n<li>&nbsp;1..n, The queries are always limited to 50 orders per page<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>E.g.:\u00a0<em><a href=\"https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/deal.xml\">https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/deal.xml<\/a><\/em>\u00a0<\/p>\n\n\n\n<p>A description of the response is described in the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">deal format description<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Search for sent platform orders<\/h2>\n\n\n\n<p>The following filters are possible<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>keywords: Partial searches in orderId , ownOrderId and customerOrderId, e.g. keywords=11SRRK<\/li>\n\n\n\n<li>orderId (or legacy by dealId): ITscope unique order number e.g. orderId=11SRRK-150126-1136<\/li>\n\n\n\n<li>ownOrderId (or legacy by ownDealId): Own order number assigned by the purchaser, e.g. ownOrderId=54321<\/li>\n\n\n\n<li>customerOrderId (or legacy by customerDealId): The order number of the end customer, e.g. customerOrderId=12345<\/li>\n\n\n\n<li>status: Filter by&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">order status<\/a>, e.g. status=ADVISED<\/li>\n\n\n\n<li>cartId: Search based on the shopping cart IDs in which the order is located*<\/li>\n<\/ul>\n\n\n\n<p>* only API 2.1, see <a href=\"https:\/\/guide.itscope.com\/en\/kb\/differences-api-2-1-to-api-2-0\/\">here<\/a>.<\/p>\n\n\n\n<p>The following query parameters are possible<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>archiv\n<ul class=\"wp-block-list\">\n<li>ARCHIVED: archived orders<\/li>\n\n\n\n<li>NOTARCHIVED: unarchived orders<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>sort &#8211; Sortierungskriterien\n<ul class=\"wp-block-list\">\n<li>LAST_MODIFIED : Change date descending<\/li>\n\n\n\n<li>SENT_DESC: Shipping date in descending order<\/li>\n\n\n\n<li>SEND_ASC: Shipping date in ascending order<\/li>\n\n\n\n<li>SUPPLIER: descending according to supplier<\/li>\n\n\n\n<li>ID: descending according to the unique ITscope orders number (orderId field)<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>page\n<ul class=\"wp-block-list\">\n<li>&nbsp;1..n, The queries are always limited to 50 orders per page<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<ul class=\"wp-block-list\">\n<li>lastUpdateDateFrom&nbsp;(only API 2.1)\n<ul class=\"wp-block-list\">\n<li>Search start date, in the format&nbsp;yyyy-MM-dd or yyyy-MM-ddThh:mm:ss or with time zones yyyy-MM-ddThh:mm:ss\u00b1hh:mm<\/li>\n\n\n\n<li>see&nbsp;&#8216;Last Modified Date Search Limitation&#8217; later in this post<\/li>\n<\/ul>\n<\/li>\n\n\n\n<li>lastUpdateDateTo (only API 2.1)\n<ul class=\"wp-block-list\">\n<li>Search end date, in the format&nbsp;yyyy-MM-dd or yyyy-MM-ddThh:mm:ss or with time zones yyyy-MM-ddThh:mm:ss\u00b1hh:mm<\/li>\n\n\n\n<li>see&nbsp;&#8216;Last Modified Date Search Limitation&#8217; later in this post<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n\n\n\n<p>Example of a search for an order number 54231 assigned by the buyer<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/ownOrderID=54231\/deal.xml\">https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/ownOrderID=54231\/deal.xml<\/a><\/p>\n\n\n\n<p>Example of a search for an end customer order number 12345<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/customerOrderID=12345\/deal.xml\">https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/customerOrderID=12345\/deal.xml<\/a><\/p>\n\n\n\n<p>Example of a search for all orders for a shopping cart with the ID 611e-ac7b-42c2-a3b6-2434812ede75<\/p>\n\n\n\n<p><a href=\"https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/cartId=611-ac7b-42c2-a3b6-2434812ede75\/deal.xml\">https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/search\/cartId=611-ac7b-42c2-a3b6-2434812ede75\/deal.xml<\/a><\/p>\n\n\n\n<p>A description of the response is described in the&nbsp;<a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">deal format description<\/a>.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Last Modified Date Search Limitation (API 2.1 only)<\/h2>\n\n\n\n<p>The corresponding request parameters are only available from API 2.1. The parameters filter on the statusDate field for orders, see <a href=\"https:\/\/guide.itscope.com\/en\/kb\/format-description-for-orders\/\">format description for deals<\/a>. The change date indicates when the last time a new response document (transaction document) was added to an order, such as a changed order confirmation or a delivery note or invoice. New orders that were created during this period are also found<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>lastUpdateDateFrom<\/strong>: The start time for restricting the order change date period in the format<strong>&nbsp;yyyy-MM-dd or yyyy-MM-ddThh:mm:ss or with time zones yyyy-MM-ddThh:mm:ss\u00b1hh:mm<\/strong>. Only if this parameter is set will the orders be filtered by the change date period.<\/li>\n\n\n\n<li><strong>lastUpdateDateTo<\/strong>: The end time for the order change date period restriction in the format <strong>yyyy-MM-dd or yyyy-MM-ddThh:mm:ss or with time zones yyyy-MM-ddThh:mm:ss\u00b1hh:mm<\/strong>. If no value is transmitted, the default value is the current date. The value cannot be less than&nbsp;<strong>lastUpdateDateFrom<\/strong>.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>These methods are for purchase orders Retrieve a list of sent platform orders The following query parameters are possible E.g.:\u00a0https:\/\/api.itscope.com\/2.1\/business\/deals\/purchase\/deal.xml\u00a0 A description of the response is described in the&nbsp;deal format &#8230;<\/p>\n","protected":false},"author":36,"featured_media":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"footnotes":""},"kbtopic":[181],"kbtag":[],"class_list":["post-15244","kb","type-kb","status-publish","hentry","kbtopic-api-methods-business"],"_links":{"self":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/15244","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\/36"}],"replies":[{"embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/comments?post=15244"}],"version-history":[{"count":4,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/15244\/revisions"}],"predecessor-version":[{"id":18511,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kb\/15244\/revisions\/18511"}],"wp:attachment":[{"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/media?parent=15244"}],"wp:term":[{"taxonomy":"kbtopic","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtopic?post=15244"},{"taxonomy":"kbtag","embeddable":true,"href":"https:\/\/guide.itscope.com\/en\/wp-json\/wp\/v2\/kbtag?post=15244"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}