SMO Restful API v2

Common Elements:

Create Order:

Get Order Detail:

Get Orders:

Get Shipments:

Create Inventory:

Get Inventory Detail:

Get Inventory:

Common Elements:

Common Request Elements
<Authentication>
<Username><Username>// Provided by SMO
<Password><Password>// Provided by SMO
<ClientID></ClientID>// Provided by SMO
<Authentication>
Common Reply Elements
<Notifications>
<Result></Result>
<Code></Code>
<Message></Message>
</Notifications>

PARAMETERS VALUES:
<OrderStatus>
NewOrder
Printed
Shipped
Received
Completed
Pending
BackOrder
Edit
Error
Canceled
ToApprove
ToDelete
Approved
Labeled
NewOrder_PM
Approved_PM
ToLabel

Create Order:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=createorder_v2

METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:

<CreateOrderRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<Order>
   <OrderID></OrderID>// Required
   <OrderDate>MM/DD/YYYY</OrderDate>// If not provided it'll default to current received date
<OrderStatus></OrderStatus> // not required
   <ShippingAddress>
      <Company></Company>
      <Name></Name> // Required
      <Street1></Street1> // Required
      <Street2></Street2>
      <City></City> // Required
      <State></State> // Required 2 digit state code for US addresses
      <Zip></Zip> // Required 5 digit zip code for US addresses
      <CountryCode></CountryCode>// 2 digit ISO country code, if not provided it will default to US
      <Phone></Phone>
      <EmailAddress></EmailAddress>
    </ShippingAddress>
    <OrderLineItems>
       <Item>
          <SKU></SKU> // Required
          <ItemName></ItemName>
          <Quantity></Quantity> // Required
          <DeclaredValue></DeclaredValue>
       </Item>
      </OrderLineItems>
      <ShippingMethod></ShippingMethod>// Required
      <SignatureRequired></SignatureRequired> // Boolean
      <SaturdayDelivery></SaturdayDelivery> // Boolean
      <Insurance></Insurance>
      <ThirdPartyAccount></ThirdPartyAccount> // FedEx or UPS third party billing account
      <ThirdPartyAccountBillingZip></ThirdPartyAccountBillingZip> // Billing Zip code associated with third party account, only required for UPS third party account shipments
      <AttachedDocs></AttachedDocs> // Boolean.
      <CommentsCustomer></CommentsCustomer> // Use to pass comments made by the customer at the time of check out
      <CommentsPackingSlip></CommentsPackingSlip> // Text included here will be printed on the packing list the customer will receive (gift message for instance)               <CommentsWarehouse></CommentsWarehouse> // Pass special packing or handling instructions to warehouse, not visible to customer
  </Order>
</CreateOrderRequest>

SUCCESS RESPONSE:

<CreateOrderReply>
<Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
<Order>
   <OrderID></OrderID>
</Order>
</CreateOrderReply>

ERROR RESPONSE:
<CreateOrderReply>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</CreateOrderReply>

Get Order Detail:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=getorderdetail_v2
METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:
<GetOrderDetailRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<Order>

  <OrderID></OrderID>
</Order>
</GetOrderDetailRequest>

SUCCESS RESPONSE:
<GetOrderDetailResponse>
<Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
<Order>
      <OrderID></OrderID>
      <OrderDate>MM/DD/YYYY</OrderDate>
    <OrderStatus></OrderStatus>
    <ShippingAddress>
      <Company></Company>
      <Name></Name>
      <Street1></Street1>
      <Street2></Street2>
      <City></City>
      <State></State>
      <Zip></Zip>
      <CountryCode></CountryCode>
      <Phone></Phone>
      <EmailAddress></EmailAddress>
    </ShippingAddress>
    <OrderLineItems>
       <Item>
          <SKU></SKU>
          <ItemName></ItemName>
          <Quantity></Quantity>
          <DeclaredValue></DeclaredValue>
       </Item>
      </OrderLineItems>
      <ShippingMethod></ShippingMethod>
      <SignatureRequired></SignatureRequired>
      <SaturdayDelivery></SaturdayDelivery>
      <Insurance></Insurance>
      <ThirdPartyAccount></ThirdPartyAccount>
      <ThirdPartyAccountBillingZip></ThirdPartyAccountBillingZip>
      <AttachedDocs></AttachedDocs>
      <CommentsCustomer></CommentsCustomer>
      <CommentsPackingSlip></CommentsPackingSlip>                      <CommentsWarehouse></CommentsWarehouse>
  <ShipDate></ShipDate>
<TrackingNumbers>
<TrackingID></TrackingID>
</TrackingNumbers>
</Order>
</GetOrderDetailResponse>

ERROR RESPONSE:
<GetOrderDetailResponse>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</GetOrderDetailResponse>

Get Orders:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=getorders_v2

METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:
<GetOrdersRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<Status></Status>
<DateFrom>YYYY-MM-DD</DateFrom>
<DateTo>YYYY-MM-DD</DateTo>

</GetOrdersRequest>

SUCCESS RESPONSE:
<GetOrdersResponse>
  <Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
  <Order>
      <Date>YYYY-MM-DD</Date>
      <OrderID></OrderID>
      <Status></Status>
  </Order>
</GetOrdersResponse>
ERROR RESPONSE:

<GetOrdersResponse>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</GetOrdersResponse>

Get Shipments:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=getshipments_v2

METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:
<GetShipmentsRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<OrderID></OrderID>
<ShipDate>YYYY-MM-DD</ShipDate>

</GetShipmentsRequest>

SUCCESS RESPONSE:
<GetShipmentsResponse>
  <Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
  <Order>
      <OrderID></OrderID>
      <Status></Status>
      <ShipDate>YYYY-MM-DD</ShipDate>
      <TrackingNumbers>
          <TrackingID></TrackingID>
      </TrackingNumbers>
  </Order>
</GetShipmentsResponse>
ERROR RESPONSE:
<GetShipmentsResponse>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</GetShipmentsResponse>

Create Inventory:

Get Inventory Detail:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=getinventorydetail_v2

METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:

<GetInventoryDetailRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<SKU></SKU>

</GetInventoryDetailRequest>

SUCCESS RESPONSE:

<GetInventoryDetailResponse>
<Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
  <Item>
  <SKU></SKU>
<MfgSKU></MfgSKU>
  <UPC></UPC>
<ItemName></ItemName>
<Active>1</Active>
    <Stock></Stock>
          <Stock_Hand></Stock_Hand>
    <Stock_DC1></Stock_DC1>
    <Stock_Hand_DC1></Stock_Hand_DC1>
      <Stock_DC2></Stock_DC2>
    <Stock_Hand_DC2></Stock_Hand_DC2>
    <Type></Type>
    <Price_Retail></Price_Retail>
    <Price_Customs></Price_Customs>
      <Commodity></Commodity>
    <Origin>US</Origin>
<Harmonized_Code></Harmonized_Code>
    <Low_Stock_Alert></Low_Stock_Alert>
    <Harmonized_Code></Harmonized_Code>
</Item>
</GetInventoryDetailResponse>
ERROR RESPONSE:
<GetInventoryDetailResponse>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</GetInventoryDetailResponse>

Get Inventory:

ENDPOINT:
URL structure (path only, no root url)

/RESTfm/SMORestAPI/layout/XML.xml?RFMformat=xmlall&RFMscript=getinventory_v2

METHOD: Post
CONTENT TYPE: Application/x-www-form-urlencoded

XML REQUEST / PARAMETERS:
<GetInventoryRequest>
<Authentication>
   <Username><Username>
   <Password><Password>
   <ClientID></ClientID>
<Authentication>
<Active></Active>

</GetInventoryRequest>

SUCCESS RESPONSE:

<GetInventoryResponse>
  <Notifications>
      <Result></Result>
          <Code></Code>
  <Message></Message>
</Notifications>
<Item>
      <SKU></SKU>
      <ItemName></ItemName>
      <Active></Active>
      <Stock></Stock>
      <Stock_DC1></Stock_DC1>
      <Stock_DC2></Stock_DC2>
  </Item>
</GetInventoryResponse>
ERROR RESPONSE:

<GetInventoryResponse>
<Notifications>
      <Result>ERROR</Result>
          <Code></Code>
  <Message></Message>
</Notifications>
</GetInventoryResponse>

Browse all templates Edit in Process Street

Stay updated—subscribe to our blog!

More templates like this

Payroll Processing – User Guide

PROCEDURE PAYROLL PROCESSING-TSHEETS &QB-Payroll Processing

How to Build a Process from Resources (Copy)

2. Entrega de proyecto

12 Month Maintenance Schedule

Resource Based Economy Transition Team Support

View all Uncategorized templates