Unofficial Pixi-API-Documentation

by koempf24.de

pixiSetItemCustomsInfo

Pixi-Docs
Old Pixi-Docs

Set item specific information

Since pixi version: LOU Official (6.3.0.4452) Additional notes: Username and date will not be updated in case all data is already in desired state

Customs

Request

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

Request body

Name Type Required Description
Width number false

Width

Type: numeric

Default value: NULL

Example: 9.99

Available from: LOU Official (6.3.0.4452)
Heigth number false

Heigth

Type: numeric

Default value: NULL

Example: 9.99

Available from: LOU Official (6.3.0.4452)
Length number false

Length

Type: numeric

Default value: NULL

Example: 9.99

Available from: LOU Official (6.3.0.4452)
Weight number false

Weight in grams

Type: numeric

Default value: NULL

Example: 9.99

Available from: LOU Official (6.3.0.4452)
ItemKey integer true

Item ID

Type: int

Default value:

Example: 123

Available from: LOU Official (6.3.0.4452)
UserName string true

User name

Type: varchar(50)

Default value:

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CustomsTariffText string false

Customs Tariff Text

Type: varchar(-1)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CustomsTariffNumber string false

Customs Tariff Number

Type: varchar(50)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CustomsCountryOfOrigin string false

Customs Country Of Origin

Type: varchar(3)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CustomsPreviousProcess string false

Previous procedure (vorangegangenes Verfahren)

Type: varchar(10)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)
CustomsCountryOfOriginISO2 string false

Customs Country Of Origin ISO2

Type: varchar(2)

Default value: NULL

Example: abcdefg

Available from: LOU Official (6.3.0.4452)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiSetItemCustomsInfo>
      <ItemKey>0</ItemKey>
      <UserName>string</UserName>
      <CustomsTariffNumber>string</CustomsTariffNumber>
      <CustomsCountryOfOrigin>string</CustomsCountryOfOrigin>
      <CustomsCountryOfOriginISO2>string</CustomsCountryOfOriginISO2>
      <Weight>0</Weight>
      <Heigth>0</Heigth>
      <Width>0</Width>
      <Length>0</Length>
      <CustomsTariffText>string</CustomsTariffText>
      <CustomsPreviousProcess>string</CustomsPreviousProcess>
    </pixiSetItemCustomsInfo>
  </Body>
</Envelope>

Response

1. Result output

Name Type Description
ResultCode string

Result Code

Type: varchar (3)

Available from: 25.06 (25.6.0.58802)
ResultMessage string

Result Message

Type: varchar (9)

Available from: 25.06 (25.6.0.58802)

Response Example

<PixiSetItemCustomsInfoPost200TextXmlResponse>
  <ResultCode>string</ResultCode>
  <ResultMessage>string</ResultMessage>
</PixiSetItemCustomsInfoPost200TextXmlResponse>

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:pixiSetItemCustomsInfo>
            <Width xsi:type="xsd:number">9.99</Width>
            <Heigth xsi:type="xsd:number">9.99</Heigth>
            <Length xsi:type="xsd:number">9.99</Length>
            <Weight xsi:type="xsd:number">9.99</Weight>
            <ItemKey xsi:type="xsd:integer">123</ItemKey> <!-- required -->
            <UserName xsi:type="xsd:string">abcdefg</UserName> <!-- required -->
            <CustomsTariffText xsi:type="xsd:string">abcdefg</CustomsTariffText>
            <CustomsTariffNumber xsi:type="xsd:string">abcdefg</CustomsTariffNumber>
            <CustomsCountryOfOrigin xsi:type="xsd:string">abcdefg</CustomsCountryOfOrigin>
            <CustomsPreviousProcess xsi:type="xsd:string">abcdefg</CustomsPreviousProcess>
            <CustomsCountryOfOriginISO2 xsi:type="xsd:string">abcdefg</CustomsCountryOfOriginISO2>
        </ns1:pixiSetItemCustomsInfo>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiSetItemCustomsInfo', [
    'Width' => '9.99', // number
    'Heigth' => '9.99', // number
    'Length' => '9.99', // number
    'Weight' => '9.99', // number
    'ItemKey' => '123', // integer (required)
    'UserName' => 'abcdefg', // string (required)
    'CustomsTariffText' => 'abcdefg', // string
    'CustomsTariffNumber' => 'abcdefg', // string
    'CustomsCountryOfOrigin' => 'abcdefg', // string
    'CustomsPreviousProcess' => 'abcdefg', // string
    'CustomsCountryOfOriginISO2' => 'abcdefg', // 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);
}