Process-status v2

Get process-status

Request a specific process-status. A process-status show information and a previously executed POST and/or PUT request. All PUT and POST requests (on other endpoints) will supply a process-status-id in their response. You can use this ID to request it’s status. e.g. if your request has already been processed.

 

GET /services/rest/process-status/v2/:id

Parameters

Name Type Description
process-status-id integer Required. The ID of the process-status being requested. This ID is supplied in every response to a PUT/POST request on the other endpoints
GET /services/rest/process-status/v2/1234567

Example response

Status: 200 OK

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns1:ProcessStatus xmlns:ns1="https://plazaapi.bol.com/services/xsd/v2/plazaapi.xsd">
 <ns1:id>1234567</ns1:id>
 <ns1:sellerId>1234567</ns1:sellerId>
 <ns1:entityId>987654321</ns1:entityId>
 <ns1:eventType>CONFIRM_SHIPMENT</ns1:eventType>
 <ns1:description>Confirm shipment for order item 987654321.</ns1:description>
 <ns1:status>FAILURE</ns1:status>
 <ns1:errorMessage>The item is already shipped or cancelled.</ns1:errorMessage>
 <ns1:createTimestamp>2016-11-14T09:34:41.000+01:00</ns1:createTimestamp>
 <ns1:Links>
 <ns1:link ns1:method="GET" ns1:href="https://plazaapi.bol.com/services/rest/process-status/v2/1234567" ns1:rel="self"/>
 </ns1:Links>
</ns1:ProcessStatus>

Response values explained

Name Type Description
id long ID of the process-status you have requested
sellerID long ID of the seller you have requested this information for
entityID string ID of the object being processed.

For example: when processing a shipment, you will receive the ID of the OrderItem being processed.

eventType string Name of the requested action that is being processed
description string describes the action that is being processed
status string status of the action being processed.

Possible values:

  • PENDING
  • SUCCESS
  • FAILURE
  • TIMEOUT
errorMessage string Shows error message if applicable
createTimestamp dateTime Time when action of which the process-status is requested has been created.
Links complexType Lists available actions applicable to this endpoint

Endpoint XSD

Download XSD for process-status-v2 endpoint.