Create a group order invitation

Request

A group order invitation allows other users to contribute to an existing order. Contributors may request an access token with the invitation ID that allows them to add line items and modify those line items.

Security

OAuth2(Required scopes: FullAccessShopper)

Bodyapplication/jsonrequired

ExpirationDatestring, (date-time)required

Maximum 1 year.

Example:"2018-01-01T00:00:00-06:00"

OrderIDstringrequired

Example:""

Namestring, <= 100 characters

Example:""

xpobject

Example:

{}

curl -i -X POST \
  https://api.ordercloud.io/v1/me/orderinvitations \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "ID": "",
    "ExpirationDate": "2018-01-01T00:00:00-06:00",
    "Name": "",
    "OrderID": "",
    "OrderStatus": "Unsubmitted",
    "xp": {}
  }'

Responses

A group order invitation allows other users to contribute to an existing order. Contributors may request an access token with the invitation ID that allows them to add line items and modify those line items.

Bodyapplication/json

IDstring, <= 100 charactersread-only

Example:""

ExpirationDatestring, (date-time)

Maximum 1 year.

Example:"2018-01-01T00:00:00-06:00"

Namestring, <= 100 characters

Example:""

OrderIDstring

Example:""

OrderStatusstring(OrderStatus)read-only

Enum:"Unsubmitted""AwaitingApproval""Declined""Open""Completed""Canceled"

Example:"Unsubmitted"

xpobject

Example:

{}

Response

{
  "ID": "",
  "ExpirationDate": "2018-01-01T00:00:00-06:00",
  "Name": "",
  "OrderID": "",
  "OrderStatus": "Unsubmitted",
  "xp": {}
}