Octopus RPC / Order Client

Octopus Store

Available Procedures

query(options) → Order[]
create(Order) → id
retrieve(code) → Order
cancel(code) → ra
awaiting-payment(code) → ra
mark-for-risk-analysis(code) → ra
turn-into-invoice(code) → ra
dispatch(code) → ra
confirm-delivery(code) → ra
mark-as-read(code) → ra
substatus(Substatus) → ra
send-mail(code) → message

Notes

ra means records affected

Underlying Specs

Order Definition

object { # | Ω(#) := "Orders"
	union {integer{1,}; null} "id";
	integer{1,} "idCustomer";
	integer{-1,} "idPayment";
	integer "idStatus" [0,1,2,3,4,5];
		# 0: CANCELADO
		# 1: AGUARDANDO_PAGAMENTO
		# 2: EM ANÁLISE
		# 3: PAGO
		# 4: ENVIADO_PARA_TRANSPORTADORA
		# 5: FINALIZADO

string{10,19} "dtIns" /^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2})?$/ ?;
	integer{1,} "code" ?;
	boolean "unread" ?;

array{
		object {
			integer{1,} "idParent" ?;
			string{,32} "sku";
			string{,4000} "name";
			number{0,} "price";
			integer{0,} "qty";
			string{,10} "uom";
			integer{0,} "width";
			integer{0,} "height";
			integer{0,} "depth";
			integer{0,} "weight";
			object{}* "custom_fields";
		}
	} "items" = [];
	number "alpha" = 1;
	number "beta" = 0;

array{
		object {
			integer{1,} "idParent" ?;
			string{,50} "name";
			string{,50} "code";
			number{0,} "value";
		}
	} "coupons_giftcards" = [];

object {
		string{,100} "street";
		string{,20} "number";
		string{,50} "poBox";
		string{,50} "neighborhood";
		string{,50} "locality";
		string{,50} "region";
		string{,50} "country";
		string{,8} "postalCode";
	} "billing_address";

string{,50} "addressee" = "";

number{0,} "shipping_cost";
	boolean "is_gift" = false;

integer{1,} "compound_interest_t";
	number "compound_interest_i";
	number "credit_card_charge";
	number "acrescimo_substituicao_tributaria";

number "buy_together_discount";

string "notes";

object{}* "custom_fields";
}

Octopus RPC / Order Client

Octopus Store

Available Procedures

Notes

Underlying Specs

Order Definition

Substatus Definition

Options Definition

Request

Response