Skip to main content

Retrieve an order

Last updated: 05-Jul-2023
Rate this article:

Overview

Use the getOrder method to retrieve details on a specific order placed with dynamic product information, or catalog products, using the unique, system-generated reference.

Parameters

Parameters Type/Description

sessionID

Required (string)

 

Session identifier, the output of the Login method. Include sessionID into all your requests. 2Checkout throws an exception if the values are incorrect.  The sessionID expires in 10 minutes.

orderReference

Required (string)

 

Order reference number of an older order, which is already approved/paid.

skipPartnerOrders Optional (boolean)
 

Default value = TRUE. 

Decides if the partner orders should be retrieved or not. By default, they are skipped and instead of returning the partner order according to the orderReference, it will return the master order.

Response

Parameters Type/Description

Order information

Object (orders with catalog products)

Order information Object (orders with dynamic product information)
WSOrder String

 

   Only orders with STATUS = COMPLETE are returned when placing a  getOrder  API call.

Request 

<?php

require ('PATH_TO_AUTH');

$orderReference = 'YOUR_ORDER_REFERENCE';
$skipPartnerOrders = 'FALSE';

try {
    $fullOrderDetails = $client->getOrder ($sessionID, $orderReference, $skipPartnerOrders);
}
catch (SoapFault $e) {
    echo "fullOrderDetails: " . $e->getMessage();
    exit;
}
var_dump("fullOrderDetails", $fullOrderDetails);
?>

 

Rate this article:

Need help?

Do you have a question? If you didn’t find the answer you are looking for in our documentation, you can contact our Support teams for more information. If you have a technical issue or question, please contact us. We are happy to help.

Not yet a Verifone customer?

We’ll help you choose the right payment solution for your business, wherever you want to sell, in-person or online. Our team of experts will happily discuss your needs.

Verifone logo