# 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 ```json Create order: test_sad1 test_sad ManageOrder 1212121212121213 ExtApi CREATE_ORDER 10 Test create order PM Praxell company Broadway 1200 New York NY 10001 Z_Progreso STAR - Low Limit 2 3 4 My Name Cardholder Approve Order: st_manager st_manager ManageOrder 1212121212121213 ExtApi APPROVE_ORDER 1 11 Test Update name st_manager 2 3 1 Test approve Cancel Order: test_sad1 test_sad ManageOrder 1212121212121213 ExtApi CANCEL_ORDER 1 Test cancel Complete: test_sad1 test_sad ManageOrder 1212121212121213 ExtApi COMPLETE_ORDER 2 Test complete order 10 12 12 120 6 8 7 2013-12-22 222 Y Manual Create Cards: st_manager st_manager ManageOrder 1212121212121213 ExtApi MANUAL_CREATE_CARDS 2 Test man create cards order 12 211 12 14 Get Order Initial Values: test_sad1 test_sad ManageOrder 1212121212121213 ExtApi GET_ORDER_INITIAL_VALUES Z_Progreso STAR - Low Limit Decline Order: stmanager st_manager ManageOrder 1212121212121213 ExtApi DECLINE_ORDER 1 Test decline Test message ``` ```json Get Order Initial Values: ManageOrder 09ad8525-9148-4943-ab37-f1eba5153d33 0 StatusOK NA 2013-12-29 14:00:02 09ad8525-9148-4943-ab37-f1eba5153d33 DistributorShipping no name ee_e bbb ccc AK 11111 ArrowEye Test Cardholder 2 4 3 000 991909 9886 7 999-222 All Others: ManageOrder 09ad8525-9148-4943-ab37-f1eba5153d33 0 StatusOK NA 2013-12-29 14:00:02 09ad8525-9148-4943-ab37-f1eba5153d33 ``` ```json ManageOrder 07071612200737105 80000 General error (no balance back from MV) General error (no balance back from MV) 2021-10-01 12:37:50 07071612200737105 ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://apidocs.juicefin.com/apis/administration/manage-order.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.