YM REST Services

Orders

**Requires Authentication**
Requires any of the roles:	admin, oauthadmin	Requires the permission:	/admin/store/

The following routes are available for this service:
POST	/Ams/{ClientID}/Orders	Create a Dues invoice.

**Orders** Parameters:
Name	Parameter	Data Type	Required
orderId	body	int	No
invoice	body	Invoice	No
StorePromoCode	body	string	No

**BaseDto** Parameters:
Name	Parameter	Data Type	Required
UsingRedis	form	bool	No
AppInitTime	form	DateTime	No
ServerID	form	string	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**Invoice** Parameters:
Name	Parameter	Data Type	Required
date	form	DateTime	No
shippingMethodId	form	int	No
shippingMethodName	form	string	No
shippingTax	form	double	No
shippingTotal	form	double	No
taxRate	form	double	No
taxTotal	form	double	No
totalAmount	form	double	No
comment	form	string	No
person	form	Person	No
shippingAddress	form	Address	No
invoiceItems	form	List<InvoiceItem>	No
isNewMember	form	bool	No
taxGLCode	form	string	No
taxQBClass	form	string	No
shippingGLCode	form	string	No
shippingQBClass	form	string	No

**Person** Parameters:
Name	Parameter	Data Type	Required
id	form	int	No
organization	form	string	No
firstName	form	string	No
lastName	form	string	No
middleName	form	string	No
nameSuffix	form	string	No
emailAddress	form	string	No
primaryAddress	form	Address	No
username	form	string	No
password	form	string	No
isMember	form	bool	No
expirationDate	form	string	No
currentMembershipAllowsMultipleOpenInvoices	form	bool	No
currentMembershipInvoiceIsOpen	form	bool	No
currentMembershipInvoiceAwaitingAutoBill	form	bool	No

**Address** Parameters:
Name	Parameter	Data Type	Required
firstName	form	string	No
lastName	form	string	No
organization	form	string	No
address1	form	string	No
address2	form	string	No
city	form	string	No
location	form	string	No
postalCode	form	string	No
countryCode	form	string	No
countryName	form	string	No
areaCode	form	string	No
phone	form	string	No

**InvoiceItem** Parameters:
Name	Parameter	Data Type	Required
itemTypeId	form	string	No
id	form	int	No
shippingCost	form	double	No
description	form	string	No
customDescription	form	string	No
taxRate	form	double	No
taxGLCode	form	string	No
quantity	form	double	No
amount	form	double	No
isProRated	form	bool	No
GLCode	form	string	No
isModifier	form	bool	No
isDuesRule	form	bool	No
taxQBClass	form	string	No
QBClass	form	string	No
sku	form	string	No
taxable	form	bool	No
autoPromoCodeAmount	form	double	No
autoPromoCodeTitle	form	string	No
salesDiscount	form	double	No
AutoPromoCode	form	AutoPromoCode	No

**AutoPromoCode** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Title	form	string	No
IsPercent	form	bool	No
Discount	form	double	No

**OrderResponse** Parameters:
Name	Parameter	Data Type	Required	Description
invoiceGuid	form	string	No
orderGuid	form	string	No

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/Orders HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Orders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StorePromoCode>String</StorePromoCode>
  <invoice>
    <comment>String</comment>
    <date>0001-01-01T00:00:00</date>
    <invoiceItems>
      <InvoiceItem>
        <AutoPromoCode>
          <Discount>0</Discount>
          <Id>0</Id>
          <IsPercent>false</IsPercent>
          <Title>String</Title>
        </AutoPromoCode>
        <GLCode>String</GLCode>
        <QBClass>String</QBClass>
        <amount>0</amount>
        <autoPromoCodeAmount>0</autoPromoCodeAmount>
        <autoPromoCodeTitle>String</autoPromoCodeTitle>
        <customDescription>String</customDescription>
        <description>String</description>
        <id>0</id>
        <isDuesRule>false</isDuesRule>
        <isModifier>false</isModifier>
        <isProRated>false</isProRated>
        <itemTypeId>String</itemTypeId>
        <quantity>0</quantity>
        <salesDiscount>0</salesDiscount>
        <shippingCost>0</shippingCost>
        <sku>String</sku>
        <taxGLCode>String</taxGLCode>
        <taxQBClass>String</taxQBClass>
        <taxRate>0</taxRate>
        <taxable>false</taxable>
      </InvoiceItem>
    </invoiceItems>
    <isNewMember>false</isNewMember>
    <person>
      <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
      <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
      <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <currentMembershipAllowsMultipleOpenInvoices>false</currentMembershipAllowsMultipleOpenInvoices>
      <currentMembershipInvoiceAwaitingAutoBill>false</currentMembershipInvoiceAwaitingAutoBill>
      <currentMembershipInvoiceIsOpen>false</currentMembershipInvoiceIsOpen>
      <emailAddress>String</emailAddress>
      <expirationDate>String</expirationDate>
      <firstName>String</firstName>
      <id>0</id>
      <isMember>false</isMember>
      <lastName>String</lastName>
      <middleName>String</middleName>
      <nameSuffix>String</nameSuffix>
      <organization>String</organization>
      <password>String</password>
      <primaryAddress>
        <address1>String</address1>
        <address2>String</address2>
        <areaCode>String</areaCode>
        <city>String</city>
        <countryCode>String</countryCode>
        <countryName>String</countryName>
        <firstName>String</firstName>
        <lastName>String</lastName>
        <location>String</location>
        <organization>String</organization>
        <phone>String</phone>
        <postalCode>String</postalCode>
      </primaryAddress>
      <username>String</username>
    </person>
    <shippingAddress>
      <address1>String</address1>
      <address2>String</address2>
      <areaCode>String</areaCode>
      <city>String</city>
      <countryCode>String</countryCode>
      <countryName>String</countryName>
      <firstName>String</firstName>
      <lastName>String</lastName>
      <location>String</location>
      <organization>String</organization>
      <phone>String</phone>
      <postalCode>String</postalCode>
    </shippingAddress>
    <shippingGLCode>String</shippingGLCode>
    <shippingMethodId>0</shippingMethodId>
    <shippingMethodName>String</shippingMethodName>
    <shippingQBClass>String</shippingQBClass>
    <shippingTax>0</shippingTax>
    <shippingTotal>0</shippingTotal>
    <taxGLCode>String</taxGLCode>
    <taxQBClass>String</taxQBClass>
    <taxRate>0</taxRate>
    <taxTotal>0</taxTotal>
    <totalAmount>0</totalAmount>
  </invoice>
  <orderId>0</orderId>
</Orders>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <StorePromoCode>String</StorePromoCode>
  <invoice>
    <comment>String</comment>
    <date>0001-01-01T00:00:00</date>
    <invoiceItems>
      <InvoiceItem>
        <AutoPromoCode>
          <Discount>0</Discount>
          <Id>0</Id>
          <IsPercent>false</IsPercent>
          <Title>String</Title>
        </AutoPromoCode>
        <GLCode>String</GLCode>
        <QBClass>String</QBClass>
        <amount>0</amount>
        <autoPromoCodeAmount>0</autoPromoCodeAmount>
        <autoPromoCodeTitle>String</autoPromoCodeTitle>
        <customDescription>String</customDescription>
        <description>String</description>
        <id>0</id>
        <isDuesRule>false</isDuesRule>
        <isModifier>false</isModifier>
        <isProRated>false</isProRated>
        <itemTypeId>String</itemTypeId>
        <quantity>0</quantity>
        <salesDiscount>0</salesDiscount>
        <shippingCost>0</shippingCost>
        <sku>String</sku>
        <taxGLCode>String</taxGLCode>
        <taxQBClass>String</taxQBClass>
        <taxRate>0</taxRate>
        <taxable>false</taxable>
      </InvoiceItem>
    </invoiceItems>
    <isNewMember>false</isNewMember>
    <person>
      <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
      <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
      <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
      <ResponseStatus xmlns:d4p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
        <d4p1:ErrorCode>String</d4p1:ErrorCode>
        <d4p1:Message>String</d4p1:Message>
        <d4p1:StackTrace>String</d4p1:StackTrace>
        <d4p1:Errors>
          <d4p1:ResponseError>
            <d4p1:ErrorCode>String</d4p1:ErrorCode>
            <d4p1:FieldName>String</d4p1:FieldName>
            <d4p1:Message>String</d4p1:Message>
            <d4p1:Meta xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </d4p1:Meta>
          </d4p1:ResponseError>
        </d4p1:Errors>
        <d4p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d4p1:Meta>
      </ResponseStatus>
      <currentMembershipAllowsMultipleOpenInvoices>false</currentMembershipAllowsMultipleOpenInvoices>
      <currentMembershipInvoiceAwaitingAutoBill>false</currentMembershipInvoiceAwaitingAutoBill>
      <currentMembershipInvoiceIsOpen>false</currentMembershipInvoiceIsOpen>
      <emailAddress>String</emailAddress>
      <expirationDate>String</expirationDate>
      <firstName>String</firstName>
      <id>0</id>
      <isMember>false</isMember>
      <lastName>String</lastName>
      <middleName>String</middleName>
      <nameSuffix>String</nameSuffix>
      <organization>String</organization>
      <password>String</password>
      <primaryAddress>
        <address1>String</address1>
        <address2>String</address2>
        <areaCode>String</areaCode>
        <city>String</city>
        <countryCode>String</countryCode>
        <countryName>String</countryName>
        <firstName>String</firstName>
        <lastName>String</lastName>
        <location>String</location>
        <organization>String</organization>
        <phone>String</phone>
        <postalCode>String</postalCode>
      </primaryAddress>
      <username>String</username>
    </person>
    <shippingAddress>
      <address1>String</address1>
      <address2>String</address2>
      <areaCode>String</areaCode>
      <city>String</city>
      <countryCode>String</countryCode>
      <countryName>String</countryName>
      <firstName>String</firstName>
      <lastName>String</lastName>
      <location>String</location>
      <organization>String</organization>
      <phone>String</phone>
      <postalCode>String</postalCode>
    </shippingAddress>
    <shippingGLCode>String</shippingGLCode>
    <shippingMethodId>0</shippingMethodId>
    <shippingMethodName>String</shippingMethodName>
    <shippingQBClass>String</shippingQBClass>
    <shippingTax>0</shippingTax>
    <shippingTotal>0</shippingTotal>
    <taxGLCode>String</taxGLCode>
    <taxQBClass>String</taxQBClass>
    <taxRate>0</taxRate>
    <taxTotal>0</taxTotal>
    <totalAmount>0</totalAmount>
  </invoice>
  <orderId>0</orderId>
  <invoiceGuid>String</invoiceGuid>
  <orderGuid>String</orderGuid>
</OrderResponse>