Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The CancelSalesOrder method is used to cancel a specific order in EDGE. 


Localtab Group
Localtab
titleCancelSalesOrder Request

The elements below are used in the CancelSalesOrder request.

Note
titleNote

• Must use Core WMS and have WMS API configured in merchant settings

• No partial cancellations

• Payments

  1. Authorized order will be cancelled/voided
  2. Captured order will have full refund go back onto existing payment method

• No OT or communication events triggered/generated

Click  for an example of this request in JSON format.

Tip
titleTip

For best results, hover the cursor over the image and click your right mouse button (or equivalent laptop button or mobile device control), then select Open link in New Window in the shortcut menu. (When prompted, select to either open the file or save the file, as preferred.)

URL: https://<service_domain>/service/order/CancelSalesOrder/<ProjectID>/jp.jws 

Element

Value/Description

Format

order

Required

Identifies order being requested against

Object

• orderHeaderId

ID of the order being requested

Note
titleNote:

Use either this or externalReference, but not both.

Integer

• externalReference

An external reference used when creating this order

Note
titleNotes:
  • Use either this or orderHeaderId, but not both.
  • If this reference refers to multiple SalesOrder orders, the associated tracking information will be returned for each order.

String

userIdentifies the user who cancelled the orderIdentifies user
• userId

ID of the user

Note
titleNote:

Use either this or username, but not both.

Integer
• username

UserName of the user

Note
titleNote:

Use either this or userId, but not both.

String



Localtab
titleCancelSalesOrder Response

The elements below are used in the CancelOrder response.

Click  for an example of the successful response in JSON format.

Click  for an example of the failed response in JSON format.

Tip
titleTip

For best results, hover the cursor over the image and click your right mouse button (or equivalent laptop button or mobile device control), then select Open link in New Window in the shortcut menu. (When prompted, select to either open the file or save the file, as preferred.)

Element

Description

Format

resultCode

Valid values include:
"OK", "FAIL"

String

resultMessage

":" or Error description, if any.

String