Skip to main content

Retrieve a specific shipping group for an order

GET 

https://useast.api.elasticpath.com/v2/orders/:orderID/shipping-groups/:shippingGroupID

Retrieve a specific shipping group for an order

Request

Path Parameters

    orderID stringrequired

    The ID of the order

    shippingGroupID stringrequired

    The ID of the shipping group

Responses

Shipping group details

Schema
    typestring

    Possible values: [shipping_group]

    idstring
    relationstring
    cart_idstring
    order_idstring
    shipping_typestring
    tracking_referencestring
    address object
    first_namestringrequired

    First name of the shipping recipient.

    last_namestringrequired

    Last name of the shipping recipient.

    phone_numberstringrequired

    Phone number of the shipping recipient.

    company_namestringrequired

    Company of the shipping recipient.

    line_1stringrequired

    First line of the shipping address.

    line_2stringrequired

    Second line of the shipping address.

    citystringrequired

    City of the shipping address.

    postcodestringrequired

    Post code of the shipping address.

    countystringrequired

    County of the shipping address.

    countrystringrequired

    Country of the shipping address.

    regionstringrequired

    State, province, or region of the shipping address.

    instructionsstringrequired

    Delivery instructions.

    delivery_estimate object
    startdate-time
    enddate-time
    createdAtdate-time
    updatedAtdate-time
    relationships object
    cart object

    Array of relationships

    data object[]

    Individual relationships

  • Array [
  • typestring

    The type of related resource.

    iduuid

    The ID of the related resource.

  • ]
  • order object

    Array of relationships

    data object[]

    Individual relationships

  • Array [
  • typestring

    The type of related resource.

    iduuid

    The ID of the related resource.

  • ]
  • discounts object[]
  • Array [
  • amount objectrequired
    amountintegerrequired

    Amount in minor currency units (e.g., cents).

    currencystringrequired

    ISO 4217 currency code (e.g., "USD").

    includes_taxbooleanrequired

    Whether the amount includes tax.

    codestring

    The discount code used, if applicable.

    idstringrequired

    Unique identifier for the discount.

    promotion_sourcestring

    The source or origin of the promotion, if applicable.

    is_cart_discountboolean

    Indicates whether the discount applies to the entire cart.

    ordinalinteger

    Order in which the discount was applied.

  • ]
  • meta object
    shipping_display_price object
    total objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    base objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    tax object
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    fees object
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    discount object
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    total_display_price object
    with_tax objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    without_tax objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    tax objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    discount objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    balance_owing objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    paid objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    authorized objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    without_discount objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    shipping objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

    shipping_discount objectrequired
    amountnumber

    The raw total.

    currencystring

    The currency set for this amount.

    formattedstring

    The formatted total based on the amount and currency.

Authorization: http

name: bearerAuthtype: httpscheme: bearer
var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://useast.api.elasticpath.com/v2/orders/:orderID/shipping-groups/:shippingGroupID");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());
Request Collapse all
Base URL
https://useast.api.elasticpath.com
Auth
Parameters
— pathrequired
— pathrequired
ResponseClear

Click the Send API Request button above and see the response here!

We use cookies to enhance your experience. By continuing to visit this site you agree to our use of cookies.