Manage Order

Manage Order

The Manage Order API allow to manage orders from creation stage to completion stage

Input Parameters:

Name
Required
Definition
Comments

ApprovedBy

Y

Format: Alphanumeric, 30

Relevant for Event values of: APPROVE_ORDER

CardsBoxesInCases

Y

Format: Numeric, 2

Relevant for Event values of: CREATE_ORDER

CardsBoxesInCasesReceived

Y

Format: Numeric, 2

Relevant for Event values of: COMPLETE_ORDER

CardsBundlesInBox

Y

Format: Numeric, 2

Relevant for Event values of: CREATE_ORDER

CardsBundlesInBoxReceived

Y

Format: Numeric, 2

Relevant for Event values of: COMPLETE_ORDER

CardsNumberInBundle

Y

Format: Numeric, 2

Relevant for Event values of: CREATE_ORDER

CardsNumberInBundleReceived

Y

Format: Numeric, 2

Relevant for Event values of: COMPLETE_ORDER

CompletionDescription

N

Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + *

& ; @ ! ~ = _ \ '

Description

N

Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + *

& ; @ ! ~ = _ \ '

Event

Y

Options: CREATE_ORDER, MANUAL_CREATE_CARDS, APPROVE_ORDER, COMPLETE_ORDER, CREATE_CARDS, MANUAL_CREATE_CARDS, CANCEL_ORDER, DECLINE_ORDER, FAILURE, GET_ORDER_INITIAL_VALUES

Relevant for all events

FromCase

O

Format: Alphanumeric, 20

Relevant for Event values of: MANUAL_CREATE_CARDS

FromCaseReceived

Y

Format: Alphanumeric, 20

Relevant for Event values of: COMPLETE_ORDER

FromRPID

O

Format: Numeric, 1-19

Relevant for Event values of: MANUAL_CREATE_CARDS

FromRPIDReceived

Y

Format: Numeric, 1-19

Relevant for Event values of: COMPLETE_ORDER

Message

N

Format: 1-500, supported characters: Blank a-z A-Z 0-9 . , # $ ( ) / : ? - % + *

& ; @ ! ~ = _ \ '

NamePrinted

Y

Format: 2-26, alpha. Can contains as well space

Relevant for Event values of: CREATE_ORDER, APPROVE_ORDER

OrderArrivalDate

Y

Format: YYYY-MM-DD

Relevant for Event values of: COMPLETE_ORDER

OrderID

Y

Format: Alphanumeric, 20

Relevant for Event values of: APPROVE_ORDER, APPROVE_ORDER, COMPLETE_ORDER, COMPLETE_ORDER, CREATE_CARDS, MANUAL_CREATE_CARDS, CANCEL_ORDER , DECLINE_ORDER , ~FAILURE

OrderShippingDestination

Y

Options: PM/Distributor/DistributorShipping/Reseller by default: None

Relevant for Event values of: CREATE_ORDER

PackageSafetyReceived

Y

Format: Y/N

Relevant for Event values of: COMPLETE_ORDER

PT

Y

Format: Alphanumeric, 1-120 Description: Each sub program in Praxell consists of one or more product types. A product type is a set of attributes that are applied to the cards that belong to this product type. The ProductTypeName field is the name of the product used when creating and issuing cards.

Relevant for Event values of: CREATE_ORDER, GET_ORDER_INITIAL_VALUES

RequestedCards

Y

Format: numeric, 6

Relevant for Event values of: CREATE_ORDER,APPROVE_ORDER

RequestedCardsReceived

Y

Format: numeric, 6

Relevant for Event values of: COMPLETE_ORDER

ResellerName

N

Format: Alphanumeric, 1-30

Relevant for Event values of: GET_ORDER_INITIAL_VALUES, CREATE_ORDER

ShippingAddress1

Y

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Relevant for Event Event of: CREATE_ORDER

ShippingAddress2

Y

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Relevant for Event values of: CREATE_ORDER

ShippingCity

Y

Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,

Relevant for Event values of: CREATE_ORDER

ShippingCompany

Y

Format: Alphanumeric, 40

Relevant for Event values of: CREATE_ORDER

ShippingState

Y

Format: Alphanumeric, 2

Relevant for Event values of: CREATE_ORDER

ShippingZip

Y

Format: Numeric, 5

Relevant for Event values of: CREATE_ORDER

ToCase

O

Format: Alphanumeric, 20

Relevant for Event values of: MANUAL_CREATE_CARDS

ToCaseReceived

Y

Format: Alphanumeric, 20

Relevant for Event values of: COMPLETE_ORDER

ToRPID

O

Format: Numeric, 1-19

Relevant for Event values of: MANUAL_CREATE_CARDS

ToRPIDReceived

Y

Format: Numeric, 1-19

Relevant for Event values of: COMPLETE_ORDER

Output Parameters:

Name
Definition
Failure Case
Success Case
Comments

BIN

Format: Numeric, 9 Description: includes BIN (6) and SUBBIN (3)

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

CardsBoxesInCases

Format: Numeric, 2

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

CardsBundlesInBox

Format: Numeric, 2

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

CardsNumberInBundle

Format: Numeric, 2

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ExistingInventoryCards

Format: Numeric, 7

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ExpirationDate

Format: MMYY

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

InvoiceFile

Format: Binary (provided in PDF file format)

Not returned

Returned

Relevant for Event values of: CREATE_ORDER

FFHouseName

Format: Alphanumeric 50

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

IncompletedPreviousOrderIDForPT

Format: Alphanumeric, 30

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

IncompletedPreviousOrderStatusForPT

Format: Alphanumeric, 30

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

NamePrintedOnCard

Format: 2-26, alpha. Can contains as well space

Not returned

Returned

OrderShippingDestination

Options: PM/Distributor/DistributorShipping/Reseller by default: None

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingAddress1

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingAddress2

Format: Alphanumeric, 30 Can contains as well all special characters beside: <, >

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingCity

Format: Alpha, 1-20 Can contains as well these special characters: /, -, space, comma, period,

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingCompany

Format: Alphanumeric, 40

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingState

Format: Alphanumeric, 2

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingType

Format: Alphanumeric 20

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

ShippingZip

Format: Numeric, 5

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

SUBBIN

Format: Numeric, 3

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

TotalDistributorPendingOrders

Format: Numeric, 2

Not returned

Returned

Relevant for Event values of: GET_ORDER_INITIAL_VALUES

XML Samples

Input XML

Create order:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_sad1</UserName>
        <UserPassword>test_sad</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>CREATE_ORDER</EventName>
        <CardsNumber>10</CardsNumber>
        <Description>Test create order</Description>
        <OrderShippingDestination>PM</OrderShippingDestination>
        <ShippingCompany>Praxell company</ShippingCompany>
        <ShippingAddress1>Broadway</ShippingAddress1>
        <ShippingAddress2>1200</ShippingAddress2>
        <ShippingCity>New York</ShippingCity>
        <ShippingState>NY</ShippingState>
        <ShippingZip>10001</ShippingZip>
        <PT>Z_Progreso STAR - Low Limit</PT>
        <BoxesInCases>2</BoxesInCases>
        <CardsInBundle>3</CardsInBundle>
        <BundlesInBox>4</BundlesInBox>
        <NamePrinted>My Name Cardholder</NamePrinted>
    </ServiceParams>
</PraxellXMLRequest>

Approve Order:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>st_manager</UserName>
        <UserPassword>st_manager</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>APPROVE_ORDER</EventName>
        <OrderId>1</OrderId>
        <CardsNumber>11</CardsNumber>
        <NamePrinted>Test Update name</NamePrinted>
        <FinanceApprovedBy>st_manager</FinanceApprovedBy>
        <BundlesInBox>2</BundlesInBox>
        <CardsInBundle>3</CardsInBundle>
        <BoxesInCases>1</BoxesInCases>
        <Description>Test approve</Description>
    </ServiceParams>
</PraxellXMLRequest>

Cancel Order:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_sad1</UserName>
        <UserPassword>test_sad</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>CANCEL_ORDER</EventName>
        <OrderId>1</OrderId>
        <Description>Test cancel</Description>
    </ServiceParams>
</PraxellXMLRequest>
Complete:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_sad1</UserName>
        <UserPassword>test_sad</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
       <EventName>COMPLETE_ORDER</EventName>
        <OrderId>2</OrderId>
        <Description>Test complete order</Description>
        <FromCaseReceived>10</FromCaseReceived>
        <ToCaseReceived>12</ToCaseReceived>
        <FromRPIDReceived>12</FromRPIDReceived>
        <ToRPIDReceived>120</ToRPIDReceived>
        <CardsInBundleReceived>6</CardsInBundleReceived>
        <BoxesInCasesReceived>8</BoxesInCasesReceived>
        <BundlesInBoxReceived>7</BundlesInBoxReceived>
        <OrderArrivalDate>2013-12-22</OrderArrivalDate>
        <CardsNumberReceived>222</CardsNumberReceived>
        <PackageSafetyReceived>Y</PackageSafetyReceived>
    </ServiceParams>
</PraxellXMLRequest>

Manual Create Cards:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>st_manager</UserName>
        <UserPassword>st_manager</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>MANUAL_CREATE_CARDS</EventName>
        <OrderId>2</OrderId>
        <Description>Test man create cards order</Description>
        <FromRPID>12</FromRPID>
        <ToRPID>211</ToRPID>
        <FromCase>12</FromCase>
        <ToCase>14</ToCase>
    </ServiceParams>
</PraxellXMLRequest>

Get Order Initial Values:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
        <UserName>test_sad1</UserName>
        <UserPassword>test_sad</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>GET_ORDER_INITIAL_VALUES</EventName>
        <PT>Z_Progreso STAR - Low Limit</PT>
    </ServiceParams>
</PraxellXMLRequest>

Decline Order:
<?xml version="1.0" ?>
<PraxellXMLRequest>
    <AuthenticationDetails>
      <UserName>stmanager</UserName>
      <UserPassword>st_manager</UserPassword>
    </AuthenticationDetails>
    <ServiceDetails>
        <ServiceName>ManageOrder</ServiceName>
        <UniqueRequestId>1212121212121213</UniqueRequestId>
    </ServiceDetails>
    <Origin>
        <OriginType>ExtApi</OriginType>
    </Origin>
    <ServiceParams>
        <EventName>DECLINE_ORDER</EventName>
        <OrderId>1</OrderId>
        <Description>Test decline</Description>
        <DeclineMessage>Test message</DeclineMessage>
    </ServiceParams>
</PraxellXMLRequest>
Get Order Initial Values:
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>ManageOrder</ServiceName>
        <SessionId>09ad8525-9148-4943-ab37-f1eba5153d33</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2013-12-29 14:00:02</ServiceDate>
        <ServiceId>09ad8525-9148-4943-ab37-f1eba5153d33</ServiceId>
    </ResponseDetails>
<ResponseParams>
  <ShippingDestination>DistributorShipping</ShippingDestination>
  <ShippingCompany>no name</ShippingCompany>
  <ShippingAddress1>ee_e</ShippingAddress1>
  <ShippingAddress2>bbb</ShippingAddress2>
  <ShippingCity>ccc</ShippingCity>
  <ShippingState>AK</ShippingState>
  <ShippingZip>11111</ShippingZip>
  <FulfillmentHouse>ArrowEye</FulfillmentHouse>
  <NamePrinted>Test Cardholder</NamePrinted>
  <ShippingType></ShippingType>
  <CardsInBundle>2</CardsInBundle>
  <BoxesInCases>4</BoxesInCases>
  <BundlesInBox>3</BundlesInBox>
  <SubBin>000</SubBin>
  <Bin>991909</Bin>
  <IncompletedPreviousOrderIDForPT></IncompletedPreviousOrderIDForPT>
  <IncompletedPreviousOrderStatusForPT></IncompletedPreviousOrderStatusForPT>
  <ExistingInventoryCards>9886</ExistingInventoryCards>
  <ExpirationDate></ExpirationDate>
  <TotalDistributorPendingOrders>7</TotalDistributorPendingOrders>
  <ProcessorIssuerID>999-222</ProcessorIssuerID>
</ResponseParams>
</PraxellXMLResponse>

All Others:
<?xml version="1.0"?>
<PraxellXMLResponse>
     <ResponseDetails>
        <ServiceName>ManageOrder</ServiceName>
        <SessionId>09ad8525-9148-4943-ab37-f1eba5153d33</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2013-12-29 14:00:02</ServiceDate>
        <ServiceId>09ad8525-9148-4943-ab37-f1eba5153d33</ServiceId>
    </ResponseDetails>
<ResponseParams></ResponseParams>
</PraxellXMLResponse>
<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>ManageOrder</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>80000</StatusCode>
    <StatusName>General error (no balance back from MV)</StatusName>
    <StatusDescription>General error (no balance back from MV)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>
PreviousManage Load AccountNextManage Org To Orgs Relation

Last updated