Below is the info about the "ORDER DELETE ENDPOINT" for the CoreCommerce API.
The Request:
<Request version="1.0">
<Authentication>
<Username><![CDATA[admin]]></Username>
<Password><![CDATA[Password1!]]></Password>
<StoreName><![CDATA[mystore]]></StoreName>
<XMLKey><![CDATA[123]]></XMLKey>
</Authentication>
<Action>ACTION_TYPE_ORDER_DELETE</Action>
<List length="2">
<Order orderNumber="1475046420-308" ></Order>
<Order orderNumber="1475046365-761" ></Order>
<Order orderNumber="1475045839-554" ></Order>
</List>
</Request>
Below is a chart of the definitions of what is in the above request, and what each search term means:
Authentication
Name | Required | Example Value | Comments |
Username | Y | "admin" or "mystorename" | You create this value inside your admin under Settings->Store API. The value you set there inside your CoreCommerce Admin Panel is the value you use here. |
Password | Y | An alphanumeric string that is hard to guess (i.e. "MyPassWord1!") | You create this value inside your admin under Settings->Store API. The value you set there inside your CoreCommerce Admin Panel is the value you use here. |
XML Key | Y | A long string to further add to the security of your API connection (i.e. "FY3D57THY32HTC3748TRC38H74TR") | You create this value inside your admin under Settings->Store API. The value you set there inside your CoreCommerce Admin Panel is the value you use here. |
Action | Y | ACTION_TYPE_ORDER_DELETE | This is telling the API which endpoint you want to work with. In this case it is ACTION_TYPE_ORDER_DELETE |
List | Y | "Length = 1" or "Length = 10" | Opens the Request by telling the API how many Customers you have included in the request. If you are adding one customer, "length" would be set to 1 as you see in the above example. If you are adding multiple customers, this should tell the API how many you are adding. |
Order orderNumber | 1475046420-308 | This is the order Number you wish to delete. |
The Response:
Response:
<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Action>ACTION_TYPE_ORDER_DELETE</Action>
<Status>SUCCESS_CODE</Status>
<Code>
</Code>
<Messages>
</Messages>
<List length="1">
< id="">
<Code>100</Code>
<Message>
<![CDATA[]]>
</Message>
</>
</List>
</Response>
Name | Comments |
Action | This will tell you the action it just processed. |
Status | SUCCESS_CODE means it was successful. Anything other than this means it failed. |
Code | "200" is a valid response and means it was successful and executed the request you made properly. Anything other than "200" means there was an error. |
Messages | This will be the message from the API telling you what the issue was IF it failed. |
List | This will show you the list of customers it successfully added. You will only see this IF you get a "200" success response code. |
Category | This will show you the ID of the customer it added for your reference. |
Code | The code related to adding or editing that customer. "100" means it was successful. |
Message | Any specific message related to adding that customer to your store. |