Unofficial Pixi-API-Documentation

by koempf24.de

pixiCACreateManualBooking

Pixi-Docs
Old Pixi-Docs

Create a manuel booking event in a Customer Account

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

Customers

Request

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

Request body

Name Type Required Description
Amount number true

Amount

Type: money

Default value:

Example:

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

Comment

Type: varchar(512)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)
CustKey integer true

CustKey

Type: int

Default value:

Example:

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

EventID

Type: varchar(3)

Default value:

Example:

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

MatchKey

Type: int

Default value: NULL

Example:

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

EventDate

Type: datetime

Default value: NULL

Example:

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

Order CurrencyId (INT): in case when will be NULL, we read base currency to use from Shops table which customer belong to.

Type: smallint

Default value: NULL

Example:

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

MatchToInvoiceNr

Type: varchar(20)

Default value: NULL

Example:

Available from: LOU Official - Update 46 (6.9.46.27927)

Request Example

<Envelope xmlns="http://schemas.xmlsoap.org/soap/envelope/">
  <Body xmlns="">
    <pixiCACreateManualBooking>
      <CustKey>0</CustKey>
      <EventID>string</EventID>
      <Amount>0</Amount>
      <EventDate>string</EventDate>
      <Comment>string</Comment>
      <MatchToInvoiceNr>string</MatchToInvoiceNr>
      <MatchKey>0</MatchKey>
      <CurrencyId>string</CurrencyId>
    </pixiCACreateManualBooking>
  </Body>
</Envelope>

Response

1. Status response

Name Type Description
ReturnCode string

OK or 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

<PixiCACreateManualBookingPost200TextXmlResponse>
  <ReturnCode>string</ReturnCode>
  <ErrorMessage>string</ErrorMessage>
</PixiCACreateManualBookingPost200TextXmlResponse>

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:pixiCACreateManualBooking>
            <Amount xsi:type="xsd:number"></Amount> <!-- required -->
            <Comment xsi:type="xsd:string"></Comment>
            <CustKey xsi:type="xsd:integer"></CustKey> <!-- required -->
            <EventID xsi:type="xsd:string"></EventID> <!-- required -->
            <MatchKey xsi:type="xsd:integer"></MatchKey>
            <EventDate xsi:type="xsd:string"></EventDate>
            <CurrencyId xsi:type="xsd:string"></CurrencyId>
            <MatchToInvoiceNr xsi:type="xsd:string"></MatchToInvoiceNr>
        </ns1:pixiCACreateManualBooking>
    </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

PHP Example

<?php

getPixiSoapClientResponse('pixiCACreateManualBooking', [
    'Amount' => '', // number (required)
    'Comment' => '', // string
    'CustKey' => '', // integer (required)
    'EventID' => '', // string (required)
    'MatchKey' => '', // integer
    'EventDate' => '', // string
    'CurrencyId' => '', // string
    'MatchToInvoiceNr' => '', // 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);
}