Introducing Our Newest Product: Endlss for Influencer & Affiliate Management 🎉  Learn About Endlss >

Using the Penny APIs

Definitions

Penny Order Types Definition
return the order was returned for a refund
replacement the order was not refunded, and a replacement item(s) were sent
wholesale a single, one-time order (not associated with an autoship)
retail a single, one-time order placed from a retail flow or guest checkout
autoship an order that processed from an autoship template
Penny Order Statuses Definition
processing typically used to indicate that the order has not shipped yet. this could also imply the order has not been fully paid for yet
shipped the order has shipped
processed the order has not shipped yet, but has been fully processed (paid for and ready to be shipped)
cancelled the order was never shipped and has been cancelled
returned the order was shipped to the customer and returned to the client for a refund
failed the order failed to process and has not shipped (this could be due to payment failure or system failures)
delivered the order has been delivered to the customer

Using the Order endpoint

The API can be leveraged to support various business models. For most cases, Penny only requires a customer_member_id and a seller_member_id (with no other customer details). Please review each flow to determine how the API should be used for your business model.

Flow 1 - All orders are for “known” persons and all orders are attributed to the primary upline (only).

IMPORTANT: This flow should not be used if the same customer has multiple unique member id’s that map to a single primary upline member ID. A contact will be created for each unique customer member ID, and will result in duplicate Penny contacts.

Example of when NOT to use this flow:

Every time Sarah places an order from Geoff, she gets a unique member id created for the order. Member IDs 1234, 5678, 45678 all belong to Sarah. Each member id is associated with the same primary upline, Geoff.

This would result in 3 contact records created for Sarah, all belonging to Geoff, which is not what we want. See Flow 3 for how to resolve this.

Flow 2 - All orders are for “known” persons and orders should only attribute to the seller of the order.

Flow 3 - Orders may be for “unknown” persons with no unique member ID. Orders will only attribute to the seller of the order.

This flow may be ideal for guest checkouts or party planning business models, where there is not always a known customer_member_id

Sample member payload

{
   "first_name":"Mary",
   "last_name":"Tester",
   "city":"Gilbert",
   "region":"Arizona",
   "country":"US",
   "postal":"85296",
   "email":"useremail@gmail.com",
   "phone":"888-123-4567",
   "locale":"en-US",
   "status":"active",
   "website":"https://www.replicatedwebsite.com",
   "join_date":"2020-06-30",
   "join_time":"07:00:00",
   "member_id":"78793",
   "sponsor_member_id":"2993",
   "enroller_member_id":"2993",
   "has_access":true,
   "member_type":"customer",
   "address_line_1":"123 N That Way",
   "is_contactable":true
}

Sample order payload

{
   "order_id":"222221",
   "seller_member_id":"6785",
   "customer_member_id":"US1234",
   "order_type":"wholesale",
   "partner_order_type":"Replicated Site",
   "order_date":"2023-09-22",
   "order_time":"07:00:00",
   "order_display_date":"2023-09-22",
   "is_autoship":false,
   "autoship_id":"",
   "total":"432.13",
   "currency_code":"USD",
   "total_tax":"32.93",
   "total_discount":"0.00",
   "status":"shipped",
   "volume":"33.9800",
   "line_items":[
      {
         "sku":"BCD012",
         "name":"Lotion 2 Pack",
         "unit_price":16.99,
         "unit_tax":null,
         "picture_url":"https://www.picturelink.com",
         "quantity":1,
         "volume":20.00,
         "line_item_id":5678,
         "parent_line_item_id":null
      },
      {
         "sku":"ABC104",
         "name":"Luxury Lotion",
         "unit_price":19.99,
         "unit_tax":null,
         "picture_url":"https://www.picturelink.com",
         "quantity":2,
         "volume":null,
         "line_item_id":9987,
         "parent_line_item_id":5678
      }
   ]
}