API Endpoints

Get All Orders

GET https://api.shopgo.me/v1/management/order/

Get list of all orders. For a full breakdown of response payload see definition of Order object.

200 Orders successfully retrieved

{
    "payload": {
        "orders": [<Order>]
    }
}

Get Order

GET https://api.shopgo.me/v1/management/order/:number

Path Parameters

Name	Type	Description
number	string	Order number

200 Order successfully retrieved

{
    "payload": {
        "orders": <Order>
    }
}

Create Payment

POST https://api.shopgo.me/v1/management/order/:number/payment/

Path Parameters

Name	Type	Description
number	string	Order number

Request Body

Name	Type	Description
body	object	Payment object

200 Payment successfully created

{
    "result": "success",
    "payload": {}
}

Use this endpoint to create a new Payment for an Order.

Request body can contain one or several fields of the Payment object. For convenience, all fields were made optional and their default values are as follows ...

Parameter	Default Value
total	order balance
method	"cash_on_delivery"
created	server date and time
transaction_data	{}

Because the default value of total is the current order balance, calling this endpoint with an empty body will create a cash-on-delivery Payment object that will settle the order. 🤘

Create Refund

Refunds are special cases of Payment and can therefore be created by calling this endpoint too.

To create a refund, set method to refund and use a negative amount for total.

Authorize Order

PATCH https://api.shopgo.me/v1/management/order/:number

Path Parameters

Name	Type	Description
number	string	order number

Request Body

Name	Type	Description
authorized	boolean	new state of order "authorized" field

200

{
    "result": "success",
    "payload": {}
}

Cancel Order

PATCH https://api.shopgo.me/v1/management/order/:number

Path Parameters

Name	Type	Description
number	string	order number

Request Body

Name	Type	Description
restock	boolean	free reserved product stock
cancelled	boolean	new value of "cancelled" field

200

{
    "result": "success",
    "payload": {}
}

Update Order Visibility

PATCH https://api.shopgo.me/v1/management/order/:number

Show or hide product from dashboard and store front ends

Path Parameters

Name	Type	Description
number	string	order number

Request Body

Name	Type	Description
visible	boolean	new value of "visible" field

200

Update Shipment

PATCH https://api.shopgo.me/v1/management/order/:number/shipment/:id

Path Parameters

Name	Type	Description
number	string	order number
id	string	shipment identifier

Request Body

Name	Type	Description
state	string	one of "ready", "shipped" or "delivered"
target_delivery	string	DateTime (see definition in Primitives)

200

{
    "result": "success",
    "payload": {}
}

Note that updating the state of a Shipment object requires the parent order to be authorized as per order processing logic.

Get User

GET https://api.shopgo.me/v1/management/user/:id

Get profile information of a dashboard user

Path Parameters

Name	Type	Description
id	string	Unique user identifier

200

{
    "result": "success",
    "payload": {
        "user": <DashboardUser>
    }
}

For a full response breakdown, see DashboardUser.

Get Tenant

GET https://api.shopgo.me/v1/management/tenant

Get information of tenant (parent) account

200

{
    "result": "success",
    "payload": {
        "tenant": <Tenant>
    },
}

For a full response breakdown, see Tenant.

Get Legal

GET https://api.shopgo.me/v1/management/settings/legal

Get legal information of store

200

{
    "result": "success",
    "payload": {
        "legal": {
            "city": "Amman",
            "email": "[email protected]",
            "country": "Jordan",
            "phone_no": "123",
            "license_no": "123",
            "tax_ref_no": "123",
            "address_line1": <BilingualString>,
            "address_line2": <BilingualString>,
            "business_name": <BilingualString>
        }
    },
}

Get Store Availability

GET https://api.shopgo.me/v1/management/order/available

Get store availability (to receive new orders)

200

{
    "result": "success",
    "payload": {
        "available": true
    }
}

Override Store Availability

PATCH https://api.shopgo.me/v1/management/order/available

Manually override store availability state

Path Parameters

Name	Type	Description
available	boolean	new availability state

200

{
    "result": "success",
    "payload": {}
}

Get Webhook URL

GET https://api.shopgo.me/v1/management/settings/webhook/:name

Retrieve a webhook URL

Path Parameters

Name	Type	Description
name	string	Webhook name

200

{
    "result": "success",
    "payload": {
        "url": "https://microservice.com/webhooks/task"
    }
}

where name is one of:

• confirm-order

• calculate-shipping-rates

Change Webhook URL

PATCH https://api.shopgo.me/v1/management/settings/webhook/:name

Change a webhook URL

Path Parameters

Name	Type	Description
name	string	Webhook name

Request Body

Name	Type	Description
url	string	New webhook URL

200

{
    "result": "success"
    "payload": {},
}

where name is one of:

• confirm-order

• calculate-shipping-rates