goody

Corporate Gifting

Server path: /goody | Type: Application | PCID required: Yes

Tools

Tool	Description
goody_delete_webhooks_id	Delete a webhook endpoint
goody_get_cards	Retrieve cards
goody_get_me	Retrieve current user
goody_get_order_batches	List order batches
goody_get_order_batches_id	Retrieve an order batch
goody_get_order_batches_id_orders	Retrieve orders for an order batch
goody_get_order_batches_id_recipients	Retrieve recipients for an order batch
goody_get_orders	List orders
goody_get_orders_id	Retrieve an order
goody_get_payment_methods	List all payment methods
goody_get_products	List all active products
goody_get_products_id	Retrieve a product
goody_get_workspaces	List all workspaces
goody_post_order_batches	Create an order batch
goody_post_order_batches_price	Calculate the price for an order batch
goody_post_orders_id_cancel	Cancel an order
goody_post_orders_id_update_expiration	Update expiration for an order
goody_post_webhooks	Create a webhook endpoint

---

goody_delete_webhooks_id

Delete a webhook endpoint

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Webhook endpoint ID
events	string[]	No	—	Filter the events you want to get webhooks for. Refer to the Webhooks list for the event names.
url	string	No	—	The URL for the webhook to call.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Webhook endpoint ID"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter the events you want to get webhooks for. Refer to the Webhooks list for the event names."
    },
    "url": {
      "type": "string",
      "description": "The URL for the webhook to call."
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_cards

Retrieve cards

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_me

Retrieve current user

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_order_batches

List order batches

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_order_batches_id

Retrieve an order batch

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Order batch ID

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Order batch ID"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_order_batches_id_orders

Retrieve orders for an order batch

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Order batch ID
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Order batch ID"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_order_batches_id_recipients

Retrieve recipients for an order batch

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Order batch ID
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Order batch ID"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_orders

List orders

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_orders_id

Retrieve an order

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_payment_methods

List all payment methods

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_products

List all active products

Parameters:

Parameter	Type	Required	Default	Description
page	integer	No	—	Page for pagination, starting at 1
per_page	integer	No	—	Items per page for pagination
use_custom_catalog	boolean	No	—	Limit to custom catalog only (for approved API partners)
country_code	string	No	—	Filter by a specific shipping country code
custom_catalog_show_inactive	boolean	No	—	Show inactive products in the custom catalog. Only for Commerce API customers with a custom catalog.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "page": {
      "type": "integer",
      "description": "Page for pagination, starting at 1"
    },
    "per_page": {
      "type": "integer",
      "description": "Items per page for pagination"
    },
    "use_custom_catalog": {
      "type": "boolean",
      "description": "Limit to custom catalog only (for approved API partners)"
    },
    "country_code": {
      "type": "string",
      "description": "Filter by a specific shipping country code"
    },
    "custom_catalog_show_inactive": {
      "type": "boolean",
      "description": "Show inactive products in the custom catalog. Only for Commerce API customers with a custom catalog."
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_get_products_id

Retrieve a product

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	Product ID
use_custom_catalog	boolean	No	—	Limit to custom catalog only (for approved API partners)

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "Product ID"
    },
    "use_custom_catalog": {
      "type": "boolean",
      "description": "Limit to custom catalog only (for approved API partners)"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_get_workspaces

List all workspaces

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

---

goody_post_order_batches

Create an order batch

Parameters:

Parameter	Type	Required	Default	Description
card_id	string	No	—	The digital greeting card to attach to gifts. A card must be specified if a message is specified, since the message is displayed after the card is opened.
cart	object	Yes	—	The cart value
expires_at	string	null	No	—	The date and time at which the order batch will expire. If not specified, the order batch does not expire. An expiry must be set for orders paid using account balance. ISO 8601 format.
from_name	string	Yes	—	The name of the sender of the order (typically a gift), to be displayed as “from”.
international_gift_cards_enabled	boolean	No	—	Whether to enable international gift cards on this order. If true and the international_shipping_tier is standard, then international gift cards can be swapped to. If false, then international gift cards are not available to be swapped to.
international_shipping_tier	string	No	—	Whether to enable international shipping on this order. disabled (default) only enables US shipping on this order. standard combined with international_gift_cards_enabled enables international gift cards. full enables the full global catalog for 100+ countries, with additional tax, duties, and freight costs.
message	string	No	—	For gifts, a message for the gift to be displayed in the digital unwrapping and email notifications, if enabled.
notifications_enabled	boolean	No	—	Direct Send only. Whether to enable notifications for Direct Send orders. If true, we send confirmation and shipping notifications to Direct Send recipients. If false, we do not send any notifications to Direct Send recipients.
payment_method_id	string	No	—	The payment method used to pay for this order batch. If not specified, defaults to the first payment method on the account. If the account has no payment methods, then the order batch creation will fail.
recipients	object[]	Yes	—	The recipients value
reserved_options	object	No	—	For approved API partners only.
scheduled_send_on	string	null	No	—	The date and time at which the order batch will be sent. If not specified, the order batch is sent immediately. If an order batch is scheduled to be sent in the future, then orders will not be created until the scheduled send time. ISO 8601 format.
send_method	string	Yes	—	The method for sending a order batch. email_and_link sends a gift email to the recipient (specify email for each recipient). link_multiple_custom_list generates a gift link without an automatic email. direct_send ships the product directly to the recipient (specify mailing_address for each recipient). For more information, see Send Methods.
swap	string	No	—	What method to use to allow recipients to swap their gift. single (default) allows the recipient to swap the gift for one item, with hidden gift prices. multiple allows them to swap for multiple items up to the gift cost, with gift prices shown. disabled disables swapping on the gift. For gift collections (gift of choice), this must not be disabled.
workspace_id	string	No	—	Workspace to create the order batch in. If not specified, creates the order batch in the oldest workspace the user has access to.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "card_id": {
      "type": "string",
      "description": "The digital greeting card to attach to gifts. A card must be specified if a message is specified, since the message is displayed after the card is opened."
    },
    "cart": {
      "type": "object",
      "description": "The cart value",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "An array of cart items."
        }
      }
    },
    "expires_at": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time at which the order batch will expire. If not specified, the order batch does not expire. An expiry must be set for orders paid using account balance. ISO 8601 format."
    },
    "from_name": {
      "type": "string",
      "description": "The name of the sender of the order (typically a gift), to be displayed as \"from\"."
    },
    "international_gift_cards_enabled": {
      "type": "boolean",
      "description": "Whether to enable international gift cards on this order. If `true` and the `international_shipping_tier` is `standard`, then international gift cards can be swapped to. If `false`, then international gift cards are not available to be swapped to."
    },
    "international_shipping_tier": {
      "type": "string",
      "description": "Whether to enable international shipping on this order. `disabled` (default) only enables US shipping on this order. `standard` combined with `international_gift_cards_enabled` enables international gift cards. `full` enables the full global catalog for 100+ countries, with additional tax, duties, and freight costs.",
      "enum": [
        "disabled",
        "standard",
        "full"
      ]
    },
    "message": {
      "type": "string",
      "description": "For gifts, a message for the gift to be displayed in the digital unwrapping and email notifications, if enabled."
    },
    "notifications_enabled": {
      "type": "boolean",
      "description": "Direct Send only. Whether to enable notifications for Direct Send orders. If `true`, we send confirmation and shipping notifications to Direct Send recipients. If `false`, we do not send any notifications to Direct Send recipients."
    },
    "payment_method_id": {
      "type": "string",
      "description": "The payment method used to pay for this order batch. If not specified, defaults to the first payment method on the account. If the account has no payment methods, then the order batch creation will fail."
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "First Name"
          },
          "last_name": {
            "type": "string",
            "description": "Last Name"
          },
          "email": {
            "type": "string",
            "description": "The email value"
          },
          "phone": {
            "type": "string",
            "description": "Optional. Phone number for text notifications. E164 format (e.g. [phone]), US only."
          },
          "mailing_address": {
            "type": "object",
            "description": "Mailing Address"
          }
        },
        "required": [
          "first_name"
        ]
      },
      "description": "The recipients value"
    },
    "reserved_options": {
      "type": "object",
      "description": "For approved API partners only.",
      "properties": {
        "custom_price_tier": {
          "type": "integer",
          "description": "For approved API partners only. A custom price tier to set on this order batch."
        }
      }
    },
    "scheduled_send_on": {
      "type": [
        "string",
        "null"
      ],
      "description": "The date and time at which the order batch will be sent. If not specified, the order batch is sent immediately. If an order batch is scheduled to be sent in the future, then orders will not be created until the scheduled send time. ISO 8601 format."
    },
    "send_method": {
      "type": "string",
      "description": "The method for sending a order batch. `email_and_link` sends a gift email to the recipient (specify `email` for each recipient). `link_multiple_custom_list` generates a gift link without an automatic email. `direct_send` ships the product directly to the recipient (specify `mailing_address` for each recipient). For more information, see [Send Methods](/introduction/send-methods).",
      "enum": [
        "email_and_link",
        "link_multiple_custom_list",
        "direct_send"
      ]
    },
    "swap": {
      "type": "string",
      "description": "What method to use to allow recipients to swap their gift. `single` (default) allows the recipient to swap the gift for one item, with hidden gift prices. `multiple` allows them to swap for multiple items up to the gift cost, with gift prices shown. `disabled` disables swapping on the gift. For gift collections (gift of choice), this must not be `disabled`.",
      "enum": [
        "single",
        "multiple",
        "disabled"
      ]
    },
    "workspace_id": {
      "type": "string",
      "description": "Workspace to create the order batch in. If not specified, creates the order batch in the oldest workspace the user has access to."
    }
  },
  "required": [
    "PCID",
    "cart",
    "from_name",
    "recipients",
    "send_method"
  ]
}

---

goody_post_order_batches_price

Calculate the price for an order batch

Parameters:

Parameter	Type	Required	Default	Description
cart	object	Yes	—	The cart value
recipients	object[]	Yes	—	The recipients value
send_method	string	Yes	—	The method for sending a order batch. email_and_link sends a gift email to the recipient (specify email for each recipient). link_multiple_custom_list generates a gift link without an automatic email. direct_send ships the product directly to the recipient (specify mailing_address for each recipient). For more information, see Send Methods.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "cart": {
      "type": "object",
      "description": "The cart value",
      "properties": {
        "items": {
          "type": "array",
          "items": {
            "type": "object"
          },
          "description": "An array of cart items."
        }
      }
    },
    "recipients": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "first_name": {
            "type": "string",
            "description": "First Name"
          },
          "last_name": {
            "type": "string",
            "description": "Last Name"
          },
          "email": {
            "type": "string",
            "description": "The email value"
          },
          "phone": {
            "type": "string",
            "description": "Optional. Phone number for text notifications. E164 format (e.g. [phone]), US only."
          },
          "mailing_address": {
            "type": "object",
            "description": "Mailing Address"
          }
        },
        "required": [
          "first_name"
        ]
      },
      "description": "The recipients value"
    },
    "send_method": {
      "type": "string",
      "description": "The method for sending a order batch. `email_and_link` sends a gift email to the recipient (specify `email` for each recipient). `link_multiple_custom_list` generates a gift link without an automatic email. `direct_send` ships the product directly to the recipient (specify `mailing_address` for each recipient). For more information, see [Send Methods](/introduction/send-methods).",
      "enum": [
        "email_and_link",
        "link_multiple_custom_list",
        "direct_send"
      ]
    }
  },
  "required": [
    "PCID",
    "cart",
    "recipients",
    "send_method"
  ]
}

---

goody_post_orders_id_cancel

Cancel an order

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    }
  },
  "required": [
    "PCID",
    "id"
  ]
}

---

goody_post_orders_id_update_expiration

Update expiration for an order

Parameters:

Parameter	Type	Required	Default	Description
id	string	Yes	—	The id value
expiration	string	Yes	—	New expiration date in ISO 8601 format

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "id": {
      "type": "string",
      "description": "The id value"
    },
    "expiration": {
      "type": "string",
      "description": "New expiration date in ISO 8601 format"
    }
  },
  "required": [
    "PCID",
    "id",
    "expiration"
  ]
}

---

goody_post_webhooks

Create a webhook endpoint

Parameters:

Parameter	Type	Required	Default	Description
events	string[]	No	—	Filter the events you want to get webhooks for. Refer to the Webhooks list for the event names.
url	string	Yes	—	The URL for the webhook to call.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "events": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Filter the events you want to get webhooks for. Refer to the Webhooks list for the event names."
    },
    "url": {
      "type": "string",
      "description": "The URL for the webhook to call."
    }
  },
  "required": [
    "PCID",
    "url"
  ]
}