Unofficial Pixi-API-Documentation

by koempf24.de

pixiCreateSDeliveryByTemplate

Pixi-Docs
Old Pixi-Docs

Deprecated

This procedure creates and returns a delivery document based on one or more supplier orders.

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes: The procedure checks the setting "Create Receipts for Purchase Orders with status." If the setting is set to "0," only Purchase Orders with status Confirmed can be used to create a Goods Receipt document. If the setting is set to "1," both Ordered and Confirmed statuses are allowed. The default setting is set to 0 (Confirmed).

Suppliers

Request

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

Request body

Name Type Required Description
LocID string true

The location ID for the delivery.

Type: varchar(3)

Default value:

Example: 001

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderNr string true

A list of supplier order numbers separated by a semicolon (;).

Type: varchar(1000)

Default value:

Example: 123;456;789

Available from: LOU Official - Update 46 (6.9.46.27927)
UserName string true

The username of the person initiating the call.

Type: varchar(50)

Default value:

Example: JohnDoe

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCreateSDeliveryByTemplate>
      <OrderNr>string</OrderNr>
      <LocID>string</LocID>
      <UserName>string</UserName>
    </pixiCreateSDeliveryByTemplate>
  </Body>
</Envelope>

Response

1. Returns details of the created delivery document.

Name Type Description
SDelHNr integer

The delivery document number.

Type: int

Available from: 25.06 (25.6.0.58802)
SDelHKey integer

The primary key of the delivery header.

Type: int

Available from: 25.06 (25.6.0.58802)
SDelHDate string

The creation date of the delivery.

Type: datetime

Available from: 25.06 (25.6.0.58802)
SDelHStatus string

The status of the delivery document.

Type: varchar

Available from: 25.06 (25.6.0.58802)
SDelHSupplNr string

The supplier number associated with the delivery.

Type: varchar

Available from: 25.06 (25.6.0.58802)
SDelHLocationID string

The ID of the location associated with the delivery.

Type: varchar

Available from: 25.06 (25.6.0.58802)
SDelHextOrderNr string

The external order number(s) linked to the delivery.

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiCreateSDeliveryByTemplatePost200TextXmlResponse>
  <SDelHKey>0</SDelHKey>
  <SDelHDate>string</SDelHDate>
  <SDelHLocationID>string</SDelHLocationID>
  <SDelHNr>0</SDelHNr>
  <SDelHStatus>string</SDelHStatus>
  <SDelHextOrderNr>string</SDelHextOrderNr>
  <SDelHSupplNr>string</SDelHSupplNr>
</PixiCreateSDeliveryByTemplatePost200TextXmlResponse>

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:pixiCreateSDeliveryByTemplate>
            <LocID xsi:type="xsd:string">001</LocID> <!-- required -->
            <OrderNr xsi:type="xsd:string">123;456;789</OrderNr> <!-- required -->
            <UserName xsi:type="xsd:string">JohnDoe</UserName> <!-- required -->
        </ns1:pixiCreateSDeliveryByTemplate>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCreateSDeliveryByTemplate', [
    'LocID' => '001', // string (required)
    'OrderNr' => '123;456;789', // string (required)
    'UserName' => 'JohnDoe', // 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);
}