{"id":12267,"date":"2017-10-31T03:17:17","date_gmt":"2017-10-31T03:17:17","guid":{"rendered":"https:\/\/www.process.st\/templates\/smo-restful-api-v1\/"},"modified":"2024-02-28T20:45:00","modified_gmt":"2024-02-28T20:45:00","slug":"smo-restful-api-v1","status":"publish","type":"post","link":"https:\/\/www.process.st\/templates\/smo-restful-api-v1\/","title":{"rendered":"SMO Restful API v1"},"content":{"rendered":"
\n

Create Order: <\/h2>\n
\n
    \n
  • ENDPOINT:\n

    URL structure (path only, no root url)
    <\/em>
    \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=create<\/strong><\/li>\n<\/ul>\n

    <\/strong><\/p>\n

      \n
    • METHOD:<\/em>  Post
      <\/strong><\/li>\n
    • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
      \n
        \n
      • XML REQUEST \/ PARAMETERS:<\/em> <\/strong>
        <\/em>
        <\/strong>\n
          <\/ul>\n<\/li>\n
        • \n

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

          \n
            \n
          • SUCCESS RESPONSE:<\/em>  Record Id Number<\/strong><\/li>\n
          • ERROR RESPONSE: \n

            <\/em><\/li>\n

          • PARAMETERS VALUES:
            <OrderStatus><\/strong>
            <\/em>NewOrder
            Printed
            Shipped
            Received
            Completed
            Pending
            BackOrder
            Edit
            Error
            Canceled
            ToApprove
            ToDelete
            Approved
            Labeled
            NewOrder_PM
            Approved_PM
            ToLabel<\/li>\n<\/ul>\n

             <\/em><\/p>\n<\/p><\/div>\n<\/section>\n

            \n

            Get Order: <\/h2>\n
            \n
              \n
            • ENDPOINT:\n

              URL structure (path only, no root url)
              <\/em>
              \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=getorder<\/p>\n

              <\/strong><\/li>\n

            • METHOD:<\/em>  Post
              <\/strong><\/li>\n
            • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
              \n
                \n
              • XML REQUEST \/ PARAMETERS:<\/em> <\/strong><\/strong>\n

                <\/strong><OrderNotification> <\/p>\n

                  <\/ul>\n

                          <\/span><Username><Username>
                          <\/span><Password><Password>
                          <\/span><ClientID><\/ClientID>
                          <OrderID><\/OrderID><\/span>
                  <\/OrderNotification><\/p>\n<\/li>\n<\/ul><\/div>\n

                  \n
                    \n
                  • SUCCESS RESPONSE:\n

                    <\/em><Date>YYYY-MM-DD<\/Date>
                    <OrderID><\/OrderID>
                    <Status><\/Status> (see below)
                    <Company><\/Company>
                    <Name><\/Name>
                    <Street1><\/Street1>
                    <Street2><\/Street2>
                    <EmailAddress><\/EmailAddress>
                    <Phone><\/Phone>
                    <Zip><\/Zip>
                    <City><\/City>
                    <State><\/State>
                    <Country><\/Country>
                    <OrderLineItems>
                            <Product>
                                    <SKU><\/SKU>
                                    <ItemName><\/ItemName>
                                    <Quantity><\/Quantity>
                            <\/Product>
                    <\/OrderLineItems>
                    <ShipDate><\/ShipDate> 
                    <ShipService><\/ShipService>
                    <TrackingNumbers>
                            <TrackingID><\/TrackingID>
                    <\/TrackingNumbers>
                    <\/span><\/li>\n<\/ul><\/div>\n

                    \n
                      \n
                    • ERROR RESPONSE: 
                      <\/em>\n<\/li>\n
                    • PARAMETERS VALUES:
                      <\/em>
                      <OrderStatus><\/strong>
                      <\/em>NewOrder
                      Printed
                      Shipped
                      Received
                      Completed
                      Pending
                      BackOrder
                      Edit
                      Error
                      Canceled
                      ToApprove
                      ToDelete
                      Approved
                      Labeled
                      NewOrder_PM
                      Approved_PM
                      ToLabel<\/li>\n<\/ul>\n

                       <\/em><\/p>\n<\/p><\/div>\n<\/section>\n

                      \n

                      Get Orders: <\/h2>\n
                      \n
                        \n
                      • ENDPOINT:\n

                        URL structure (path only, no root url)
                        <\/em>
                        \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=getorders<\/strong><\/li>\n<\/ul>\n

                        <\/strong><\/p>\n

                          \n
                        • METHOD:<\/em>  Post
                          <\/strong><\/li>\n
                        • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
                          \n
                            \n
                          • XML REQUEST \/ PARAMETERS:<\/em> <\/strong>\n

                            <\/strong><OrderNotification>
                            <\/span>        <\/span><Username><Username>
                                    <\/span><Password><Password>
                                    <\/span><ClientID><\/ClientID>
                                    <Status><\/Status>
                            <\/span>        <DateFrom<\/span>>YYYY-MM-DD<\/DateFrom>
                            <\/span>        <DateTo<\/span>>YYYY-MM-DD<\/DateTo><\/span>
                            <\/OrderNotification><\/li>\n<\/ul><\/div>\n

                            \n
                              \n
                            • SUCCESS RESPONSE:\n

                              <\/em><OrderNotification>
                                      <Order>
                                      <Date>YYYY-MM-DD<\/Date>
                                      <OrderID><\/OrderID>
                                      <Status><\/Status>
                                      <\/Order>
                              <\/OrderNotification><\/p>\n

                              <\/span>
                              <\/span><\/li>\n

                            • ERROR RESPONSE: \n

                              <\/em><\/li>\n

                            • PARAMETERS VALUES:
                              <OrderStatus><\/strong>
                              <\/em>NewOrder
                              Printed
                              Shipped
                              Received
                              Completed
                              Pending
                              BackOrder
                              Edit
                              Error
                              Canceled
                              ToApprove
                              ToDelete
                              Approved
                              Labeled
                              NewOrder_PM
                              Approved_PM
                              ToLabel<\/li>\n<\/ul>\n

                               <\/em><\/p>\n<\/p><\/div>\n<\/section>\n

                              \n

                              Get Tracking: <\/h2>\n
                              \n
                                \n
                              • ENDPOINT:\n

                                URL structure (path only, no root url)
                                <\/em>
                                \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=getorders<\/strong><\/li>\n<\/ul>\n

                                <\/strong><\/p>\n

                                  \n
                                • METHOD:<\/em>  Post
                                  <\/strong><\/li>\n
                                • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
                                  \n
                                    \n
                                  • XML REQUEST \/ PARAMETERS:<\/em> <\/strong>\n

                                    <\/strong><OrderNotification>
                                    <\/span>        <\/span><Username><Username>
                                            <\/span><Password><Password>
                                            <\/span><ClientID><\/ClientID>
                                            <OrderID><\/OrderID>
                                    <\/span><\/OrderNotification><\/li>\n<\/ul><\/div>\n

                                    \n
                                      \n
                                    • SUCCESS RESPONSE:\n

                                      <\/em><TrackingNumbers>
                                              <TrackingID><\/TrackingID>
                                      <\/TrackingNumbers><\/p>\n

                                      <\/span>
                                      <\/span><\/li>\n

                                    • ERROR RESPONSE:<\/em><\/li>\n<\/ul><\/div>\n<\/section>\n
                                      \n

                                      Get Inventory: <\/h2>\n
                                      \n
                                        \n
                                      • ENDPOINT:\n

                                        URL structure (path only, no root url)
                                        <\/em>
                                        \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=getinventory<\/strong><\/li>\n<\/ul>\n

                                        <\/strong><\/p>\n

                                          \n
                                        • METHOD:<\/em>  Post
                                          <\/strong><\/li>\n
                                        • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
                                          \n
                                            \n
                                          • XML REQUEST \/ PARAMETERS:<\/em> <\/strong>\n

                                            <\/strong><OrderNotification>
                                            <\/span>        <\/span><Username><Username>
                                                    <\/span><Password><Password>
                                                    <\/span><ClientID><\/ClientID>
                                                    <Active><\/Active>
                                            <\/span><\/OrderNotification><\/li>\n<\/ul><\/div>\n

                                            \n
                                              \n
                                            • SUCCESS RESPONSE:\n

                                              <\/em><InventoryNotification>
                                                      <Item>
                                                              <SKU><\/SKU>
                                                              <ItemName><\/ItemName>
                                                              <Active><\/Active>
                                                              <Stock><\/Stock>
                                                              <Stock_DC1><\/Stock_DC1>
                                                              <Stock_DC2><\/Stock_DC2>
                                                      <\/Item>
                                              <\/InventoryNotification>
                                              <\/span>
                                              <\/span><\/li>\n

                                            • ERROR RESPONSE:<\/em><\/li>\n<\/ul><\/div>\n<\/section>\n
                                              \n

                                              Get Item: <\/h2>\n
                                              \n
                                                \n
                                              • ENDPOINT:\n

                                                URL structure (path only, no root url)
                                                <\/em>
                                                \/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=getinventory<\/strong><\/li>\n<\/ul>\n

                                                <\/strong><\/p>\n

                                                  \n
                                                • METHOD:<\/em>  Post
                                                  <\/strong><\/li>\n
                                                • CONTENT TYPE:<\/em> Application\/x-www-form-urlencoded<\/strong><\/li>\n<\/ul><\/div>\n
                                                  \n
                                                    \n
                                                  • XML REQUEST \/ PARAMETERS:<\/em> <\/strong>\n

                                                    <\/strong><OrderNotification>
                                                    <\/span>        <\/span><Username><Username>
                                                            <\/span><Password><Password>
                                                            <SKU><\/SKU><\/span>
                                                    <\/span><\/OrderNotification><\/li>\n<\/ul><\/div>\n

                                                    \n
                                                      \n
                                                    • SUCCESS RESPONSE:
                                                      <\/em>
                                                      <Item>
                                                              <SKU><\/SKU>
                                                              <Stock><\/Stock>
                                                              <Stock_NV><\/Stock_NV>
                                                              <Stock_Hand_NV><\/Stock_Hand_NV>
                                                              <Type><\/Type>
                                                              <Stock_Hand><\/Stock_Hand>
                                                              <Price_Retail><\/Price_Retail>
                                                              <Price_Customs><\/Price_Customs>
                                                              <Origin>US<\/Origin>
                                                              <Low_Stock_Alert><\/Low_Stock_Alert>
                                                              <Harmonized_Code><\/Harmonized_Code>
                                                              <Desc><\/Desc>
                                                              <Comodity><\/Comodity>
                                                              <Active><\/Active>
                                                      <\/Item>
                                                      <\/span>
                                                      <\/span><\/li>\n
                                                    • ERROR RESPONSE:<\/em><\/li>\n<\/ul><\/div>\n<\/section>\n","protected":false},"excerpt":{"rendered":"

                                                      Create Order: ENDPOINT: URL structure (path only, no root url)\/RESTfm\/SMORestAPI\/layout\/XML.xml?RFMformat=xmlall&RFMscript=create METHOD:  Post CONTENT TYPE: Application\/x-www-form-urlencoded XML REQUEST \/ PARAMETERS:  <Username><Username><Password><Password><ClientID><\/ClientID><OrderNotification>        <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> […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"closed","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"ep_exclude_from_search":false,"cover_icon_emoji":"","cover_icon_url":"","tasks_count":"6","template_description":"","template_id":"kB2RhK5dR58i3E19aypIhg","task_0":"Create Order:","task_slug_0":"create-order","task_1":"Get Order:","task_slug_1":"get-order","task_2":"Get Orders:","task_slug_2":"get-orders","task_3":"Get Tracking:","task_slug_3":"get-tracking","task_4":"Get Inventory:","task_slug_4":"get-inventory","task_5":"Get Item:","task_slug_5":"get-item","task_6":"","task_slug_6":"","task_7":"","task_slug_7":"","task_8":"","task_slug_8":"","task_9":"","task_slug_9":"","task_10":"","task_slug_10":"","task_11":"","task_slug_11":"","task_12":"","task_slug_12":"","task_13":"","task_slug_13":"","task_14":"","task_slug_14":"","task_15":"","task_slug_15":"","task_16":"","task_slug_16":"","task_17":"","task_slug_17":"","task_18":"","task_slug_18":"","task_19":"","task_slug_19":"","task_20":"","task_slug_20":"","task_21":"","task_slug_21":"","task_22":"","task_slug_22":"","task_23":"","task_slug_23":"","task_24":"","task_slug_24":"","task_25":"","task_slug_25":"","task_26":"","task_slug_26":"","task_27":"","task_slug_27":"","task_28":"","task_slug_28":"","task_29":"","task_slug_29":"","task_30":"","task_slug_30":"","task_31":"","task_slug_31":"","task_32":"","task_slug_32":"","task_33":"","task_slug_33":"","task_34":"","task_slug_34":"","task_35":"","task_slug_35":"","task_36":"","task_slug_36":"","task_37":"","task_slug_37":"","task_38":"","task_slug_38":"","task_39":"","task_slug_39":"","task_40":"","task_slug_40":"","task_41":"","task_slug_41":"","task_42":"","task_slug_42":"","task_43":"","task_slug_43":"","task_44":"","task_slug_44":"","task_45":"","task_slug_45":"","task_46":"","task_slug_46":"","task_47":"","task_slug_47":"","task_48":"","task_slug_48":"","task_49":"","task_slug_49":"","task_50":"","task_slug_50":"","task_51":"","task_slug_51":"","task_52":"","task_slug_52":"","task_53":"","task_slug_53":"","task_54":"","task_slug_54":"","task_55":"","task_slug_55":"","task_56":"","task_slug_56":"","task_57":"","task_slug_57":"","task_58":"","task_slug_58":"","task_59":"","task_slug_59":"","task_60":"","task_slug_60":"","task_61":"","task_slug_61":"","task_62":"","task_slug_62":"","task_63":"","task_slug_63":"","task_64":"","task_slug_64":"","task_65":"","task_slug_65":"","task_66":"","task_slug_66":"","task_67":"","task_slug_67":"","task_68":"","task_slug_68":"","task_69":"","task_slug_69":"","task_70":"","task_slug_70":"","task_71":"","task_slug_71":"","task_72":"","task_slug_72":"","task_73":"","task_slug_73":"","task_74":"","task_slug_74":"","task_75":"","task_slug_75":"","task_76":"","task_slug_76":"","task_77":"","task_slug_77":"","task_78":"","task_slug_78":"","task_79":"","task_slug_79":"","task_80":"","task_slug_80":"","task_81":"","task_slug_81":"","task_82":"","task_slug_82":"","task_83":"","task_slug_83":"","task_84":"","task_slug_84":"","task_85":"","task_slug_85":"","task_86":"","task_slug_86":"","task_87":"","task_slug_87":"","task_88":"","task_slug_88":"","task_89":"","task_slug_89":"","task_90":"","task_slug_90":"","task_91":"","task_slug_91":"","task_92":"","task_slug_92":"","task_93":"","task_slug_93":"","task_94":"","task_slug_94":"","task_95":"","task_slug_95":"","task_96":"","task_slug_96":"","task_97":"","task_slug_97":"","task_98":"","task_slug_98":"","task_99":"","task_slug_99":"","footnotes":""},"categories":[7,1],"tags":[],"class_list":["post-12267","post","type-post","status-publish","format-standard","hentry","category-miscellaneous","category-uncategorized"],"acf":[],"aioseo_notices":[],"_links":{"self":[{"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/posts\/12267","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/comments?post=12267"}],"version-history":[{"count":0,"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/posts\/12267\/revisions"}],"wp:attachment":[{"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/media?parent=12267"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/categories?post=12267"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/www.process.st\/templates\/wp-json\/wp\/v2\/tags?post=12267"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}