Orders

This module manage all order data

Orders - Add a new orderpost

Access data from one single order by giving one specific id

Url

https://api.vinou.de/service/orders/add

Parameter

Field Type Description
payment_type String

type of payment (required).

source String

source keyword where the order is registered (required).

billing Array

billing address (required).

delivery Array

delivery address (required).

items Array

items of order (required).

package Array

package item of order (required).

returnUrl String

url of finish page after paypal payment is accepted (required if paypal is payment_method).

cancelUrl String

url of cancel page after paypal payment is cancelled (required if paypal is payment_method).

{
	"token": "9a9a9a",
	"authid": "8b8b8b",
	"billing": {
		"type": "new",
		"name": "Christian Händel",
		"company": "Interfrog Produktion GmbH",
		"address": "Hauptstraße 161",
		"zip": "68259",
		"city": "Mannheim",
		"country": "Deutschland",
		"mail": "c.haendel@division.ag"
	},
	"delivery": {
		"type": "new",
		"name": "Maria Musterfrau",
		"company": "Muster AG",
		"address": "Musterweg 987",
		"zip": "65432",
		"city": "Musterdorf",
		"country": "Deutschland",
		"mail": "maria@musterdomain.de"
	},
	"payment_type": "paypal",
	"source": "shop",
	"returnUrl": "https://shop.vinou.de/checkout/finish",
	"cancelUrl": "https://shop.vinou.de/checkout/cancel",
	"items": [
		{
		  "type": "wine",
		  "id": 185,
		  "quantity": 6
		},
		{
		  "type": "wine",
		  "id": 186,
		  "quantity": 12
		},
		{
		  "type": "wine",
		  "id": 263,
		  "quantity": 24
		}
	],
	"package": {
		"type": "package",
		"id": 5
	}
}
Orders - cancel orderpost

cancel specific order by given uuid

Url

https://api.vinou.de/service/orders/checkout/cancel

Parameter

Field Type Description
order_id String

uuid of the order must be stored in session before (required).

{
  "token": "9a9a9a",
  "authid": "8b8b8b",
  "order_id": "fca93b1b-0d49-5c54-b37a-51b6c71843bf"
}
Orders - Edit an existing orderpost

Edit data from one single order by giving one specific id

Url

https://api.vinou.de/service/orders/edit

Parameter

Field Type Description
id Integer

Unique ID of order to update (required).

order Array

Array of new order data (required) !importannt you cant update addresses in this routing its only to update status or general things like payment_type.

{
	"token": "9a9a9a",
	"authid": "8b8b8b",
	"id": 123,
	"order": {
		"status": "in_payment",
		"payment_type": "invoice"
	}
}
Orders - finish orderpost

Finish an existing order its payment is realized with an external payment method like paypal

Url

https://api.vinou.de/service/orders/checkout/finish

Parameter

Field Type Description
payment_type String

method for payment for example "paypal" (required).

payment_id String

uuid of payment is part of the returnUrl (required).

order_id String

uuid of the order must be stored in session before (required).

external_id String

external payment id mostly given in return url (required).

payer_id String

id of payer mostly given in return url (required).

{
  "token": "9a9a9a",
  "authid": "8b8b8b",
  "payment_type": "paypal",
  "payment_id": "d99c6fbf-9de6-54a0-b93e-ddb48d7e890e",
  "order_id": "fca93b1b-0d49-5c54-b37a-51b6c71843bf",
  "external_id": "PAY-7FS80726G4658932TLGZ7JKQ",
  "payer_id": "SPE87Y8U7CGH4"
}
Orders - Get single orderpost

Access data from one single order by giving one specific id

Url

https://api.vinou.de/service/orders/get

Parameter

Field Type Description
id Integer

Unique ID of order (required).

{
  "token": "9a9a9a",
  "authid": "8b8b8b",
  "id": 185,
}
Orders - Get all orderspost

Access all orders from the customer that registered the token

Url

https://api.vinou.de/service/orders/getAll

Parameter

No parameter available for this function

{
  "token": "9a9a9a",
  "authid": "8b8b8b"
}