Unofficial Pixi-API-Documentation

by koempf24.de

pixiSupplierOrderChangeStatus

Pixi-Docs
Old Pixi-Docs

Change status on supplier order. Id - Status of supplier order 1 - NEW 2 - ORDERED 3 - CONFIRMED 4 - CLOSED

Since pixi version: AVA Official - Update 7 (8.4.7.23158) Additional notes:

General

Request

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

Request body

Name Type Required Description
UserId integer false

(optional parameter) Id of user who execute API call.

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
AppName string true

Name of application which execute API call.

Type: varchar(255)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
UserName string true

User name of user who execute API call.

Type: varchar(50)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderId integer false

(optional parameter) Id of (one) supplier order. Example: @SupplierOrderId = 13

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderNR integer false

(optional parameter) InternalNumber of (one) supplier order. Example: @SupplierOrderNR = 70000013

Type: int

Default value:

Example:

Available from: AVA Official - Update 23 (8.4.23.27873)
ChangeStatusIdTo integer true

Id of status to which we are changing .

Type: int

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)
SupplierOrderIds string false

(optional parameter) Ids of (more) supplier orders in strings separated with comma. Example: @SupplierOrderIds = ('13','25')

Type: varchar(8000)

Default value:

Example:

Available from: AVA Official - Update 7 (8.4.7.23158)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSupplierOrderChangeStatus>
      <AppName>string</AppName>
      <UserId>0</UserId>
      <UserName>string</UserName>
      <ChangeStatusIdTo>0</ChangeStatusIdTo>
      <SupplierOrderId>0</SupplierOrderId>
      <SupplierOrderIds>string</SupplierOrderIds>
      <SupplierOrderNR>0</SupplierOrderNR>
    </pixiSupplierOrderChangeStatus>
  </Body>
</Envelope>

Response

1. Status output

Name Type Description
ReturnCode string

Return Code (Success/ERROR)

Type: varchar

Available from: 25.06 (25.6.0.58802)
ErrorMessage string

Error message

Type: varchar

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSupplierOrderChangeStatusPost200TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiSupplierOrderChangeStatusPost200TextXmlResponse>

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:pixiSupplierOrderChangeStatus>
            <UserId xsi:type="xsd:integer"></UserId>
            <AppName xsi:type="xsd:string"></AppName> <!-- required -->
            <UserName xsi:type="xsd:string"></UserName> <!-- required -->
            <SupplierOrderId xsi:type="xsd:integer"></SupplierOrderId>
            <SupplierOrderNR xsi:type="xsd:integer"></SupplierOrderNR>
            <ChangeStatusIdTo xsi:type="xsd:integer"></ChangeStatusIdTo> <!-- required -->
            <SupplierOrderIds xsi:type="xsd:string"></SupplierOrderIds>
        </ns1:pixiSupplierOrderChangeStatus>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSupplierOrderChangeStatus', [
    'UserId' => '', // integer
    'AppName' => '', // string (required)
    'UserName' => '', // string (required)
    'SupplierOrderId' => '', // integer
    'SupplierOrderNR' => '', // integer
    'ChangeStatusIdTo' => '', // integer (required)
    'SupplierOrderIds' => '', // 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);
}