Sign in

v1

latestSwagger 2.02026-07-13301635.0 KB
orders

sends an order in a single step. This is much easier than using other order commands

Sends an order in one step. No need to create then process order. Optionally include a gift card.

post/orders/singleStepOrder

Request body

uidstring required

The UID of the logged-in user

card_idinteger required

the id of the card you want to send

denomination_idinteger

Optional. Use if sending a gift card

messagestring required

the full message body. Use '\n' for new lines

font_labelstring

the colloquial name of the font, such as 'Fancy Jenna' or 'Casual David'

sender_namestring

the name on the return address

sender_business_namestring

the second line of the return address. Optional.

sender_address1string

the first address line of the return address

sender_address2string

the second line of the address, such as suite, apartment, building, etc. Optional

sender_citystring

the city of the sender, to appear in the return address

sender_statestring

the ABBREVIATED state or province of the sender. This is required for US and Canada addresses and optional for all other countries

sender_zipstring

The postal code or zip code of the sender.

sender_countrystring

the country of the recipient. Optional and defaults to usa

sender_country_idinteger

alternate way to specify country. Optional and defaults to 1

recipient_namestring

the name on the recipient address

recipient_business_namestring

the second line of the recipient address. Optional.

recipient_address1string

the first address line of the return address

recipient_address2string

the second line of the address, such as suite, apartment, building, etc. Optional

recipient_citystring

the city of the recipient, to appear in the address

recipient_statestring

the ABBREVIATED state or province of the recipient. This is required for US and Canada addresses and optional for all other countries

recipient_zipstring

the zip code or postal code of the recipient

recipient_countrystring

the country of the recipient. Optional and defaults to usa

recipient_country_idinteger

alternate way to specify country. Optional and defaults to 1

credit_card_idinteger

the credit card id to charge for the order. Currently this is required, even for invoiced accounts, it just won't be charged.

Example request

{
  "uid": "fhqwfuihuifqwhiuwqfhiqwfh124",
  "card_id": 3404,
  "denomination_id": 12,
  "message": "Dear Frank,\nThank you so much for your interest in our services.\nYours,\nJoe",
  "font_label": "Chill Charity",
  "sender_name": "Joe Sender",
  "sender_business_name": "Handwrytten",
  "sender_address1": "1430 E Indian School Road",
  "sender_address2": "Suite 100",
  "sender_city": "Phoenix",
  "sender_state": "AZ",
  "sender_zip": "12345",
  "sender_country": "United States",
  "sender_country_id": 1,
  "recipient_name": "Cosmo Spacely",
  "recipient_business_name": "Spacely Space Sprockets",
  "recipient_address1": "123 E Main Street",
  "recipient_address2": "Second Floor",
  "recipient_city": "Burlington",
  "recipient_state": "ON",
  "recipient_zip": "L7L 0E9",
  "recipient_country": "Canada",
  "recipient_country_id": 2,
  "credit_card_id": 34124
}

Response

successful order placement

statusstring

Example response

{
  "status": "OK",
  "response": {
    "id": 42,
    "for_free": true,
    "message": "How do I love thee?  Let me count the ways",
    "card": {
      "id": 42,
      "price": 3.5,
      "category_id": 33,
      "available_free": 1
    },
    "address_from": {
      "id": 978214798,
      "name": "Joe Smith",
      "business_name": "Handwrytten LLC",
      "address1": "1430 E Indian School Rd",
      "address2": "Suite 100",
      "city": "Phoenix",
      "state": "AZ",
      "country": "United States"
    }
  }
}