You can provide an endpoint that Vinoshipper will notify of changes in your account. All webhooks have the same format, and include the URL where you can get the full details of the order or customer that has been created or updates.

{
  "identifier": Order or customer ID,
  "subject": ORDER|CUSTOMER,
  "event": APPROVED|CREATED|UPDATED|CANCELLED|DELETED|CARD_DECLINED|TRACKING_NUMBER_ADDED,
  "href": Deprecated, use hrefV3 instead,
  "hrefV3": URL to the resource, pointing to our newer v3 api
}

To add a web hook, go to Account -> Integrations -> Webhooks and specify the URL of your webhook listener.

If you do not see webhooks as an option, contact [email protected] to have webhooks enabled for your account.

Events

Once web hooks are enabled you will start receiving events for customer and order changes.

Customer Events

The event subject will be CUSTOMER and the identifier will contain the id of the customer.

Event Types

• CREATED A customer has been created.
• UPDATED One or more of s customer's attributes as been updated.
• DELETED A customer has been deleted.

Order Events

The event subject will be ORDER and the identifier will be container the order number.

• APPROVED An order has been approved.
• CREATED A new completed order has been created.
• UPDATED An order has been updated.
• CANCELLED An order has been cancelled.
• CARD_DECLINED An order failed to be created due to a credit card decline.
• TRACKING_NUMBER_ADDED A new tracking number has been added to an order.