user_invitations
Description
This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a list of user_invitations
- POST
- Create a new user_invitation
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "...",
"title": "This Collection"
},
"first": {
"href": "...?offset=0",
"title": "First Page of this Collection"
},
"prev": {
"href": "...?offset=0",
"title": "Previous Page of this Collection"
},
"next": {
"href": "...?offset=0",
"title": "Next Page of this Collection"
},
"last": {
"href": "...?offset=0",
"title": "Last Page of this Collection"
}
},
"_embedded": {
"fx:user_invitations": [...]
},
"total_items": "5",
"returned_items": 5,
"limit": 20,
"offset": 0
}
<?xml version="1.0" encoding="UTF-8"?> <resource href="..."> <link rel="self" href="..." title="This Collection"/> <link rel="first" href="...?offset=0" title="First Page of this Collection"/> <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/> <link rel="next" href="...?offset=0" title="Next Page of this Collection"/> <link rel="last" href="...?offset=0" title="Last Page of this Collection"/> <resource href="..." rel="https://api.foxycart.com/rels/user_invitation"> ... </resource> <total_items>5</total_items> <returned_items>5</returned_items> <limit>20</limit> <offset>0</offset> </resource>
{
"properties": {
"total_items": "5",
"returned_items": 5,
"limit": 20,
"offset": 0
},
"entities": [...],
"links": [
{
"rel": [
"self"
],
"href": "..."
},
{
"rel": [
"first"
],
"href": "...?offset=0"
},
{
"rel": [
"prev"
],
"href": "...?offset=0"
},
{
"rel": [
"next"
],
"href": "...?offset=0"
},
{
"rel": [
"last"
],
"href": "...?offset=0"
}
],
"actions": [
]
}
Embedded Resource: user_invitation
Description
Invitation for a user to access a certain store. The payload for a POST request should only include the invitee's email, which cannot match an existing email for the store. (To resend an invitation, use the fx:resend link rel.) NOTE: Invitations sent in this way currently are not fully functional. Please contact us if you need to use this functionality.
Interact with this resource
To interact with this resource and see it in the context of the API, you can utilise Postman or your Terminal/Console to perform requests. If you have a Foxy store, you can also use the API browser in the admin to interact with resources connected to your store.
Actions
- GET
- View a user_invitation
- PATCH
- Update a user_invitation (send only the properties you want to modify)
- HEAD
- Get just the header response
- OPTIONS
- Get a response explaining which HTTP methods are supported
Properties
| Property | Description | Type | Constraints |
|---|---|---|---|
| store_url | URL of the store that the user is invited to | String | Read only |
| store_name | Name of the store that the user is invited to | String | Read only |
| store_email | Email of the store that the user is invited to | String | Read only |
| store_domain | Domain of the store that the user is invited to | String | Read only |
| first_name | First name of the user | String | Optional |
| last_name | Last name of the user | String | Optional |
| Email of the user | String | Required | |
| status | Status of the invitation. Possible values are sent, accepted, rejected, revoked, expired. |
String | Read only |
| date_created | The date this resource was created. | Date | Read only |
| date_modified | The date this resource was last modified. | Date | Read only |
Example Representation
{
"_links": {
"curies": [
{
"name": "fx",
"href": "https://api.foxycart.com/rels/{rel}",
"templated": true
}
],
"self": {
"href": "https://api.foxycart.com/user_invitations/4",
"title": "This User Invitation"
},
"fx:store": {
"href": "https://api.foxycart.com/stores/12345",
"title": "This Store"
},
"fx:resend": {
"href": "https://api.foxycart.com/user_invitations/12345/resend",
"title": "Resend the email for this invitation"
},
"fx:user": {
"href": "https://api.foxycart.com/users/",
"title": "This User"
}
},
"store_url": "http://www.example.com/",
"store_name": "Example Store",
"store_email": "john@example.com",
"store_domain": "example",
"first_name": "Mary",
"last_name": "Smith",
"email": "mary@example.com",
"status": "sent",
"date_created": "2022-12-01T10:07:05-0800",
"date_modified": "2022-12-01T10:07:05-0800"
}
<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/user_invitations/4" rel="https://api.foxycart.com/rels/user_invitation">
<link rel="self" href="https://api.foxycart.com/user_invitations/4" title="This User Invitation"/>
<link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/12345" title="This Store"/>
<link rel="https://api.foxycart.com/rels/resend" href="https://api.foxycart.com/user_invitations/12345/resend" title="Resend the email for this invitation"/>
<link rel="https://api.foxycart.com/rels/user" href="https://api.foxycart.com/users/" title="This User"/>
<store_url>http://www.example.com/</store_url>
<store_name>Example Store</store_name>
<store_email>john@example.com</store_email>
<store_domain>example</store_domain>
<first_name>Mary</first_name>
<last_name>Smith</last_name>
<email>mary@example.com</email>
<status>sent</status>
<date_created>2022-12-01T10:07:05-0800</date_created>
<date_modified>2022-12-01T10:07:05-0800</date_modified>
</resource>
{
"class": [
"user_invitation"
],
"properties": {
"store_url": "http://www.example.com/",
"store_name": "Example Store",
"store_email": "john@example.com",
"store_domain": "example",
"first_name": "Mary",
"last_name": "Smith",
"email": "mary@example.com",
"status": "sent",
"date_created": "2022-12-01T10:07:05-0800",
"date_modified": "2022-12-01T10:07:05-0800"
},
"links": [
{
"rel": [
"self"
],
"href": "https://api.foxycart.com/user_invitations/4"
},
{
"rel": [
"https://api.foxycart.com/rels/store"
],
"href": "https://api.foxycart.com/stores/12345"
},
{
"rel": [
"https://api.foxycart.com/rels/resend"
],
"href": "https://api.foxycart.com/user_invitations/12345/resend"
},
{
"rel": [
"https://api.foxycart.com/rels/user"
],
"href": "https://api.foxycart.com/users/"
}
],
"actions": [
{
"name": "self",
"title": "Update User Invitation",
"method": "PATCH",
"href": "https://api.foxycart.com/user_invitations/4",
"type": "application/x-www-form-urlencoded",
"fields": [
{
"name": "store_url",
"title": "Store URL",
"type": "url",
"value": "http://www.example.com/"
},
{
"name": "store_name",
"title": "Store Name",
"type": "text",
"value": "Example Store"
},
{
"name": "store_email",
"title": "Store Email",
"type": "email",
"value": "john@example.com"
},
{
"name": "store_domain",
"title": "Store Domain",
"type": "text",
"value": "example"
},
{
"name": "first_name",
"title": "First Name",
"type": "text",
"value": "Mary"
},
{
"name": "last_name",
"title": "Last Name",
"type": "text",
"value": "Smith"
},
{
"name": "email",
"title": "Email",
"type": "email",
"value": "mary@example.com"
},
{
"name": "status",
"title": "Status",
"type": "text",
"value": "sent"
}
]
}
]
}
Zoomable Resources
This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.