Orders

Get Order

get/api/v1/orders/{order_id}

Request

  • Base URL: https://api.g3m.co (the document declares no server; this is the origin it was published from)
  • URL: https://api.g3m.co/api/v1/orders/{order_id}
  • Auth: none declared

Path parameters

order_idstring uuid required

Response

Successful Response

idstring uuid required
order_numberstring required
status'draft' | 'submitted' | 'sourcing' | 'awaiting_customer' | 'proposals_ready' | 'proposal_approved' | 'payment_method_required' | 'payment_processing' | 'payment_action_required' | 'payment_failed' | 'paid' | 'ready_for_fulfillment' | 'fulfilling' | 'shipped' | 'delivered' | 'completed' | 'rejected' | 'cancelled' required
mailing_type'letter' required
recipient_namestring required
companystring nullable required
created_atstring date-time required
submitted_atstring date-time nullable required
account_idstring uuid required
created_by_user_idstring uuid required
has_saved_payment_methodboolean required
request_urlstring required
payment_setup_requiredboolean
payment_setup_urlstring nullable
payment_action_urlstring nullable
payment_retry_availableboolean

Changes

No recorded changes to this operation across all 1 revision of this API.