Shops

One order with its history

get/shops/{shopId}/orders/{orderId}

Request

  • Base URL: https://hostingsurge.com/api/v1
  • URL: https://hostingsurge.com/api/v1/shops/{shopId}/orders/{orderId}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie __Host-hs_session

Path parameters

shopIdstring uuid required
orderIdstring uuid required

Response

The order

idstring uuid required
numberstring required
status'pending' | 'awaiting_payment' | 'paid' | 'fulfilled' | 'partially_refunded' | 'refunded' | 'canceled' required
testboolean required

Paid through the test gateway: no money moved

currencystring required
emailstring required
phonestring nullable required
customerNamestring nullable required
customerIdstring uuid nullable required
companystring nullable required
buyerVatNumberstring nullable required
subtotalMinorinteger required

Minor units of the shop currency (öre, cents)

discountMinorinteger required

Minor units of the shop currency (öre, cents)

shippingMinorinteger required

Minor units of the shop currency (öre, cents)

vatMinorinteger required

Minor units of the shop currency (öre, cents)

totalMinorinteger required

Minor units of the shop currency (öre, cents)

refundedMinorinteger required

Minor units of the shop currency (öre, cents)

pricesIncludeVatboolean required
vatRegime'domestic' | 'distance_seller_rates' | 'distance_destination_rates' | 'reverse_charge' | 'export' required
vatNote'reverse_charge' | 'export' | 'null' nullable required
paymentProvider'stripe_connect' | 'manual' | 'test' required
paymentMethod'stripe' | 'bank_transfer' | 'swish' | 'pickup' | 'invoice' | 'test' required
paymentReferencestring nullable required
notestring nullable required
languagestring required
needsAttentionboolean required

Paid after its reservation ran out and not enough stock was left: contact the customer

reservedUntilstring nullable required

ISO-8601 timestamp

paidAtstring nullable required

ISO-8601 timestamp

fulfilledAtstring nullable required

ISO-8601 timestamp

canceledAtstring nullable required

ISO-8601 timestamp

createdAtstring required

ISO-8601 timestamp

Changes

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