| Both sides previous revisionPrevious revisionNext revision | Previous revision |
| v:0.7.2:api [2012/11/21 03:23] – [Customer] adam | v:0.7.2:api [2017/04/26 07:02] (current) – external edit 127.0.0.1 |
|---|
| ====== The FoxyCart API ====== | ====== The FoxyCart API ====== |
| |
| | <WRAP TIP> |
| | __**NOTE: This XML API will be deprecated**__ |
| | Though this legacy XML API works and will continue to function in the future, it will not see any new functionality. We recommend any new integrations are built on top of our new Hypermedia API: https://api.foxycart.com/ |
| | </WRAP> |
| ===== Before You Get Started With the API ===== | ===== Before You Get Started With the API ===== |
| Like any API, FoxyCart's API is geared towards advanced users only. If you're not comfortable with programming, you should probably get familiar with your language of choice first or look for professional assistance. Never test on a live store, as you can certainly create problems that could impact your customers or your revenue. | Like any API, FoxyCart's API is geared towards advanced users only. If you're not comfortable with programming, you should probably get familiar with your language of choice first or look for professional assistance. Never test on a live store, as you can certainly create problems that could impact your customers or your revenue. |
| : **Required Fields:** | : **Required Fields:** |
| * ''customer_id'' //or// ''customer_email'' | * ''customer_id'' //or// ''customer_email'' |
| * ''address_id'' //or// ''address_name'' (''address_name'' is the name assigned to each multi-ship address, a customers default shipping address is recorded as "Me") | * ''address_id'' //or// ''address_name'' (''address_name'' is the shipto name assigned to each multi-ship address (as specified in the add to cart), a customers default shipping address is recorded as "Me") |
| : **Notes:** Only applicable for stores using multi-ship. | : **Notes:** Only applicable for stores using multi-ship. |
| ; ''customer_address_save'' | ; ''customer_address_save'' |
| : **Required Fields:** | : **Required Fields:** |
| * ''customer_id'' //or// ''customer_email'' | * ''customer_id'' //or// ''customer_email'' |
| * ''address_id'' //or// ''address_name'' (''address_name'' is the name assigned to each multi-ship address, a customers default shipping address is recorded as "Me") | * ''address_id'' //or// ''address_name'' (''address_name'' is the shipto name assigned to each multi-ship address (as specified in the add to cart), a customers default shipping address is recorded as "Me") |
| : **Notes:** Only applicable for stores using multi-ship. | : **Notes:** Only applicable for stores using multi-ship. |
| : **Record Fields:** ''address_name'', ''shipto_first_name'', ''shipto_last_name'', ''shipto_company'', ''shipto_address1'', ''shipto_address2'', ''shipto_city'', ''shipto_state'', ''shipto_postal_code'', ''shipto_country'' | : **Record Fields:** ''address_name'', ''shipto_first_name'', ''shipto_last_name'', ''shipto_company'', ''shipto_address1'', ''shipto_address2'', ''shipto_city'', ''shipto_state'', ''shipto_postal_code'', ''shipto_country'' |
