Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateSupplierOrderFromProfile

Pixi-Docs
Old Pixi-Docs

API call to create supplier/purchase orders from suggestion profile

Since pixi version: 19.01 (8.4.49.36788) Additional notes: ####Helpful Information 1) The user that is used to create the purchase/supplier orders is always "API".

    2) Items cannot be added to existing purchase/supplier orders with this call - no matter the configuration of the used profile.
     
    ----------
    ####**Troubleshooting**
    **How to get the "ProfileID"**
    
    The profile ID is only displayed when manually opening a profile in pixi* Web. Check the URL in the browser to see the "profileId".
     
    ----------
    ####**Error Messages**
    _Supplier Order Suggestion Profile not found!_
    
    The provided supplier order suggestion profile could not be found in the database. Use an existing profile ID.
Orderlines Orders

Request

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

Request body

Name Type Required Description
ProfileId string true

Supplier/purchase order profile ID

Type: smallint

Default value: NULL

Example: 7

Available from: 19.01 (8.4.49.36788)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateSupplierOrderFromProfile>
      <ProfileId>string</ProfileId>
    </pixiCreateSupplierOrderFromProfile>
  </Body>
</Envelope>

Response

1. SupplierOrderSuggestion result

Name Type Description
SupplNr string

Supplier number

Type: varchar (4)

Available from: 25.06 (25.6.0.58802)
SupplOrderNr integer

Supplier/purchase order number

Type: int

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreateSupplierOrderFromProfilePost200TextXmlResponse>
  <SupplOrderNr>0</SupplOrderNr>
  <SupplNr>string</SupplNr>
</PixiCreateSupplierOrderFromProfilePost200TextXmlResponse>

2. SupplierOrderSuggestion result

Name Type Description
Status string

Execution status

Type: varchar(100)

Available from: 25.06 (25.6.0.58802)
Message string

Status description

Type: varchar (1024)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreateSupplierOrderFromProfilePost200TextXmlResponse>
  <SupplOrderNr>0</SupplOrderNr>
  <SupplNr>string</SupplNr>
</PixiCreateSupplierOrderFromProfilePost200TextXmlResponse>

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:pixiCreateSupplierOrderFromProfile>
            <ProfileId xsi:type="xsd:string">7</ProfileId> <!-- required -->
        </ns1:pixiCreateSupplierOrderFromProfile>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateSupplierOrderFromProfile', [
    'ProfileId' => '7', // string (required)
]);

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);
}