Group Ordering

Check out our new set of features to support group ordering workflows.

Use Cases

• I am an office manager and want to invite people to add items to an lunch order

• I manage a team of people who need to be able to add order supplies for their department to a single order

Key Highlights

• Any buyer user with the Shopper role may invite other users to contribute to an order they created

• ExpirationDate on invitations can be used to communicate deadlines for ordering

  • For example, if lunch orders have to be in by 10am, you would set the expiration date on the invitation(s) accordingly

  • Expired Invitations are deleted automatically

  • No tokens will be granted from an expired invitation.

• OrderInvitation tokens

  • May be used by one or many people

    • If you want specific people to be able to only see the items they have added to the order, create an invitation for each person and share them separately

    • If you want people to be able to see the items others have added to the order, create a single invitation and share it with anyone you want

  • Used to add line items to the order and edit or delete those line items.

  • Cannot edit or view any line items on the order not associated with the OrderInvitationID.

  • Only the order creator may submit the order.

New Property

LineItem.InvitationID

• read-only

• Set when an order contributor creates a line item. Null in all other cases.

• Line items can be filtered on InvitationID

New Resource: GroupOrderInvitation

1{ 
2    "ID": "", 
3    "ExpirationDate": "2024-09-06 16:33:44.480", 
4    "xp": {} 
5}

New Endpoints

• GET v1/me/orderinvitations

• GET v1/me/orderinvitations/{invitationID}

• POST v1/me/orderinvitations

• PATCH v1/me/orderinvitations/{invitationID}

• DELETE v1/me/orderinvitations/{invitationID}

• POST v1/grouporders/{invitationID}/token

Creating an Order Invitation

• After creating an order, call POST v1/me/orderinvitations

  • OrderID and ExpirationDate are required

  • order invitations support XP and allow the user to set an expiration date with a one year max

• Use the ID from the response to invite other users to contribute to your order

• Only the order creator may create an order invitation

• Limit of 100 invitations per order

Contributing to an order

• Contributors will access the order by requesting a token from POST v1/grouporders/{invitationID}/token

• Use the token to add line items to the order

• Contributors may only view and edit line items created using the same InvitationID

• Contributors access the OrderCloud API with an extremely limited role which only allows access to the invited order and line items

  • The cart endpoints must be used to access the order and lineitems

  • Me endpoints must be used to browse products

    • only products purchasable by the order originator will be visible and can be added to the order

• Optionally store information about the person adding items and store it on LineItem xp, for example you could require someone to provide their name in the UI prior to adding items so that information can be stored and referenced

Still have questions?
Ask in our Community Channel

Content Powered By