pixiGetOrderComments

Pixi-Docs

This API call returns all order comments, with their creation date and user, filtered by the order number or the order number shop.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: This API call returns order comments, optionally filtered by order number.

    **How it works:**
    - The order is identified by `@OrderNr` (internal pixi* order number) and/or `@OrderNrShop` (order number external, also known as shop order number).
    - If neither `@OrderNr` nor `@OrderNrShop` is provided, all comments are returned (no order filter).
    - If both are provided, comments matching either the internal or the external order number are returned.
    - Only comments created after `@Since` are returned. If `@Since` is not provided, all comments are returned.
    
    **Row limit:**
    - The result set is always limited to a maximum of **1000 rows**.
    - If `@RowCount` is not provided or `0`, it is set to `1000`.
    - If `@RowCount` is greater than `1000`, it is capped at `1000`.

Replacements Returns

Request

POST https://apigateway.descartes.com/tms/pixi/pixiGetOrderComments

Request body

Name	Type	Required	Description
Since	string	false	Returns only comments created after this date/time. If NULL, defaults to '2000-01-01'. Type: datetime Default value: 2000-01-01 Example: date format: YYYYMMDD hh:mm:ss[.mmm] Available from: (26.6.0.11854)
OrderNr	integer	false	Filter by internal pixi* order number. If neither `@OrderNr` nor `@OrderNrShop` is provided, all comments are returned. Type: int Default value: NULL Example: 120544 Available from: LOU Official - Update 46 (6.9.46.27927)
RowCount	integer	false	Maximum number of returned rows. If NULL or 0 it is set to 1000. If greater than 1000 it is capped to 1000. Type: int Default value: 1000 Example: 100 Available from: (26.6.0.11854)
OrderNrShop	string	false	Filter by order number external (shop order number). If neither `@OrderNr` nor `@OrderNrShop` is provided, all comments are returned. Type: varchar(50) Default value: NULL Example: 20100602114632 Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiGetOrderComments>
      <OrderNr>0</OrderNr>
      <OrderNrShop>string</OrderNrShop>
      <Since>string</Since>
      <RowCount>0</RowCount>
    </pixiGetOrderComments>
  </Body>
</Envelope>

Response

1. List of order comments matching the provided filter, limited to `@RowCount` rows. If neither `@OrderNr` nor `@OrderNrShop` is provided, all comments are returned.

Name	Type	Description
Comment	string	Order comment text. Type: varchar Available from: / (26.6.0.11854)
OrderNr	integer	Internal pixi* order number. Type: int Available from: / (26.6.0.11854)
CreateEmp	string	pixi* user name that created the comment. Type: varchar Available from: / (26.6.0.11854)
CreateDate	string	Date and time the comment was created. Type: datetime Available from: / (26.6.0.11854)
OrderNrExternal	string	Order number external (shop order number). Type: varchar Available from: / (26.6.0.11854)

Response Example

<PixiGetOrderCommentsPost200TextXmlResponse>
  <Comment>string</Comment>
  <CreateEmp>string</CreateEmp>
  <CreateDate>string</CreateDate>
  <OrderNrExternal>string</OrderNrExternal>
  <OrderNr>0</OrderNr>
</PixiGetOrderCommentsPost200TextXmlResponse>

HTTP Example

POST https://apigateway.descartes.com/tms/pixi/
Content-Type: text/xml; charset=utf-8
# echo -n '{{username}}:{{password}}' | base64 | pbcopy
Authorization: Basic {{token}}

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"
                   xmlns:ns1="https://apigateway.descartes.com/tms/pixi/"
                   xmlns:xsd="http://www.w3.org/2001/XMLSchema"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
                   SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <SOAP-ENV:Body>
        <ns1:pixiGetOrderComments>
            <Since xsi:type="xsd:string">date format: YYYYMMDD hh:mm:ss[.mmm]</Since>
            <OrderNr xsi:type="xsd:integer">120544</OrderNr>
            <RowCount xsi:type="xsd:integer">100</RowCount>
            <OrderNrShop xsi:type="xsd:string">20100602114632</OrderNrShop>
        </ns1:pixiGetOrderComments>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiGetOrderComments', [
    'Since' => 'date format: YYYYMMDD hh:mm:ss[.mmm]', // string
    'OrderNr' => '120544', // integer
    'RowCount' => '100', // integer
    'OrderNrShop' => '20100602114632', // string
]);

function getPixiSoapClientResponse(string $method, array $arguments = [])
{
    $soapArguments = [];
    foreach ($arguments as $key => $value) {
        $soapArguments[] = new SoapVar($value, null, '', '', $key);
    }

    $soapClient = new SoapClient(null, [
        'login' => '...',
        'password' => '...',
        'uri' => 'https://apigateway.descartes.com/tms/pixi/',
        'location' => 'https://apigateway.descartes.com/tms/pixi/',
    ]);

    return $soapClient->__call($method, $soapArguments);
}

Unofficial Pixi-API-Documentation

by koempf24.de