Skip to content

Instantly share code, notes, and snippets.

@BDQ
Last active December 24, 2015 10:19
Show Gist options
  • Save BDQ/6783858 to your computer and use it in GitHub Desktop.
Save BDQ/6783858 to your computer and use it in GitHub Desktop.
VPD endpoint.json
{
"name": "vpd",
"display": "VPD Endpoint",
"description": "Shipping integration with VPD",
"help": "http://guides.spreecommerce.com/integration/vpd_integration.html",
"icon_url": "vpd.png",
"services": [
{
"name": "shipments",
"path": "/service/spree_order.p",
"description": "Send shipment details to VPD.",
"requires": {
"parameters": [
{
"name": "customer_id",
"description": "VPD Customer ID",
"data_type": "string"
}
]
},
"recommends": {
"messages": [
"shipment:ready"
],
"options": {
"retries_allowed": true
}
}
},
{
"name": "pickup",
"path": "/service/spree_pickup.p",
"description": "Poll VPD for shipment pickups.",
"requires": {
"parameters": [
{
"name": "customer_id",
"description": "VPD Customer ID",
"data_type": "string"
},
{
"name": "last_pickup_shipment",
"description": "Poll for shipment pickups after this number",
"data_type": "string"
}
]
},
"recommends": {
"messages": [
"vpd:shipment:pickup:poll"
],
"schedule": {
"count": 15,
"interval": "minutes"
},
"options": {
"retries_allowed": true
}
}
},
{
"name": "confirmation",
"path": "/service/spree_confirmation.p",
"description": "Poll VPD for shipment confirmations.",
"requires": {
"parameters": [
{
"name": "customer_id",
"description": "VPD Customer ID",
"data_type": "string"
},
{
"name": "last_confirmation_shipment",
"description": "Poll for shipment confirmations after this number",
"data_type": "string"
}
]
},
"recommends": {
"messages": [
"vpd:shipment:confirmation:poll"
],
"schedule": {
"count": 15,
"interval": "minutes"
},
"options": {
"retries_allowed": true
}
}
},
{
"name": "stock_query",
"path": "/service/spree_stock_inv.p",
"description": "Query VPD stock levels.",
"requires": {
"parameters": [
{
"name": "customer_id",
"description": "VPD Customer ID",
"data_type": "string"
}
]
},
"recommends": {
"messages": [
"stock:query"
],
"options": {
"retries_allowed": true
}
}
}
]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment