Unofficial Pixi-API-Documentation

by koempf24.de

pixiBreakOrderline

Pixi-Docs
Old Pixi-Docs

Deprecated

Since pixi version: LOU Official - Update 46 (6.9.46.27927) Additional notes:

Orderlines Orders

Request

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

Request body

Name Type Required Description
BinRef integer false

Type: int

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
NewQty integer false

Type: int

Default value:

Example:

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

Type: varchar(50)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
NewStatus string false

Type: varchar(3)

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
InvlineRef integer false

Type: int

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
OrderlineKey integer false

Type: int

Default value:

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiBreakOrderline>
      <OrderlineKey>0</OrderlineKey>
      <NewQty>0</NewQty>
      <NewStatus>string</NewStatus>
      <InvlineRef>0</InvlineRef>
      <UserName>string</UserName>
      <BinRef>0</BinRef>
    </pixiBreakOrderline>
  </Body>
</Envelope>

Response

Name Type Description

Response Example

<PixiBreakOrderlinePost200TextXmlResponse />

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:pixiBreakOrderline>
            <BinRef xsi:type="xsd:integer"></BinRef>
            <NewQty xsi:type="xsd:integer"></NewQty>
            <UserName xsi:type="xsd:string"></UserName>
            <NewStatus xsi:type="xsd:string"></NewStatus>
            <InvlineRef xsi:type="xsd:integer"></InvlineRef>
            <OrderlineKey xsi:type="xsd:integer"></OrderlineKey>
        </ns1:pixiBreakOrderline>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiBreakOrderline', [
    'BinRef' => '', // integer
    'NewQty' => '', // integer
    'UserName' => '', // string
    'NewStatus' => '', // string
    'InvlineRef' => '', // integer
    'OrderlineKey' => '', // integer
]);

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