Goody home pagelight logodark logo
  • Commerce API Keys
  • Automation API Keys
Schemas
RecipientInput
  • Documentation
  • API Reference
  • Order Batches
    • POST
      Create an order batch
    • GET
      List all order batches
    • GET
      Retrieve an order batch
    • GET
      Retrieve orders for an order batch
    • GET
      Retrieve recipients for an order batch
    • POST
      Calculate the price for an order batch
    Orders
    • GET
      List all orders
    • GET
      Retrieve an order
    • POST
      Cancel an order
    • POST
      Update expiration for an order
    Products
    • GET
      List all active products
    • GET
      Retrieve a product
    Payment Methods
    • GET
      List all payment methods
    Workspaces
    • GET
      List all workspaces
    Cards
    • GET
      List all active cards
    Me
    • GET
      Retrieve current user
    Schemas
    • Schemas
      • Error
      • ListMeta
      • OrderBatch
      • Order
      • OrderBatchRecipient
      • Cart
      • CartItem
      • OrderBatchSendStatus
      • OrderStatus
      • Shipment
      • Product
      • Brand
      • ProductImage
      • ProductVariant
      • Image
      • MailingAddress
      • Me
      • Sender
      • OrderBatchInput
      • CartInput
      • CartItemInput
      • OrderBatchSendMethod
      • RecipientInput
    Schemas

    RecipientInput

    The schema is of type object.

    OrderBatchSendMethod
    twitterlinkedininstagram
    Powered by Mintlify
    {
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "mailing_address": {
        "first_name": "<string>",
        "last_name": "<string>",
        "address_1": "<string>",
        "address_2": "<string>",
        "city": "<string>",
        "state": "<string>",
        "postal_code": "<string>",
        "country": "<string>"
      }
    }