POST api/OmsRmaCreate?requestJSON={requestJSON}&apiSuffix={apiSuffix}&trackingInformation={trackingInformation}

Checks if message should be sent to queue or immediately processed. Returns messageId as a GUID string if successfully queued, otherwise null

Request Information

URI Parameters

Name	Description	Type	Additional information
requestJSON	JSON serialized format of message to be put on queue	string	Required
apiSuffix	API suffix that message is meant for, such as: api/OmsInboundASN (without leading slash)	string	Required
trackingInformation	Details to be added to internal logging to track this message back to an order, etc.	string	Required

Body Parameters

Add custom headers that need to be retained, such as API version, or shipwire specific header. Do not add standard headers such as accepts or content-type

Dictionary of string [key] and string [value]

Request Formats

application/json, text/json

Sample:

{
  "sample string 1": "sample string 2",
  "sample string 3": "sample string 4"
}

application/xml, text/xml

Sample:

<ArrayOfKeyValueOfstringstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <KeyValueOfstringstring>
    <Key>sample string 1</Key>
    <Value>sample string 2</Value>
  </KeyValueOfstringstring>
  <KeyValueOfstringstring>
    <Key>sample string 3</Key>
    <Value>sample string 4</Value>
  </KeyValueOfstringstring>
</ArrayOfKeyValueOfstringstring>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns messageId as a GUID string if successfully queued, otherwise null

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>